openapi: 3.0.3 info: title: GSMTasks Project API version: 2.4.13 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. paths: /account_roles/: get: operationId: account_roles_list parameters: - name: account required: false in: query description: account schema: type: string - name: activated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: activated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: activated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: activated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: activated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: activated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: activated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: activated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: activated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: activated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: deleted_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: deleted_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: deleted_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: deleted_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: deleted_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: deleted_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: deleted_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: deleted_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: deleted_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: deleted_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: display_name required: false in: query description: display_name schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: is_active required: false in: query example: true schema: type: boolean - name: is_integration required: false in: query description: is_integration schema: type: string - name: is_manager required: false in: query description: is_manager schema: type: string - name: is_worker required: false in: query description: is_worker 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 - name: state required: false in: query description: state schema: type: string enum: - inactive - active - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: user required: false in: query description: user schema: type: string tags: - account_roles security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedAccountRoleList' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedAccountRoleList' description: '' post: operationId: account_roles_create parameters: - in: query name: format schema: type: string enum: - json - xml tags: - account_roles requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountRole' application/xml: schema: $ref: '#/components/schemas/AccountRole' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountRole' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/AccountRole' description: '' /account_roles/{id}/: get: operationId: account_roles_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - 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.4.13: schema: $ref: '#/components/schemas/AccountRole' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/AccountRole' description: '' put: operationId: account_roles_update parameters: - in: query name: format schema: type: string enum: - json - xml - 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' application/xml: schema: $ref: '#/components/schemas/AccountRole' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountRole' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/AccountRole' description: '' patch: operationId: account_roles_partial_update parameters: - in: query name: format schema: type: string enum: - json - xml - 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' application/xml: schema: $ref: '#/components/schemas/PatchedAccountRole' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountRole' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/AccountRole' description: '' delete: operationId: account_roles_destroy parameters: - in: query name: format schema: type: string enum: - json - xml - 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 parameters: - in: query name: format schema: type: string enum: - json - xml - 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' application/xml: schema: $ref: '#/components/schemas/AccountRoleActivation' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountRoleActivation' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/AccountRoleActivation' description: '' /account_roles/{id}/notify/: post: operationId: account_roles_notify_create parameters: - in: query name: format schema: type: string enum: - json - xml - 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.4.13: schema: $ref: '#/components/schemas/AccountRole' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/AccountRole' description: '' /account_roles/{id}/token/: get: operationId: account_roles_token_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - 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.4.13: schema: $ref: '#/components/schemas/AccountRoleToken' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/AccountRoleToken' description: '' /accounts/: get: operationId: accounts_list parameters: - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - accounts security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedAccountList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedAccountList' description: '' /accounts/{id}/: get: operationId: accounts_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Account' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Account' description: '' put: operationId: accounts_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Account' multipart/form-data: schema: $ref: '#/components/schemas/Account' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Account' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Account' description: '' patch: operationId: accounts_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedAccount' multipart/form-data: schema: $ref: '#/components/schemas/PatchedAccount' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Account' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Account' description: '' /accounts/{id}/braintree_customer/: get: operationId: accounts_braintree_customer_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Account' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Account' description: '' /accounts/{id}/change_owner/: post: operationId: accounts_change_owner_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountOwnerChange' multipart/form-data: schema: $ref: '#/components/schemas/AccountOwnerChange' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountOwnerChange' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountOwnerChange' description: '' /accounts/{id}/managers/: get: operationId: accounts_managers_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/AccountUser' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountUser' description: '' post: operationId: accounts_managers_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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/AccountUser' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountUser' multipart/form-data: schema: $ref: '#/components/schemas/AccountUser' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountUser' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountUser' description: '' delete: operationId: accounts_managers_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this account. required: true tags: - accounts security: - tokenAuth: [] responses: '204': description: No response body /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: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountStripePaymentMethodAttach' multipart/form-data: schema: $ref: '#/components/schemas/AccountStripePaymentMethodAttach' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripePaymentMethodAttach' application/xlsx; version=2.4.13: 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: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountStripeSetupIntentCreate' multipart/form-data: schema: $ref: '#/components/schemas/AccountStripeSetupIntentCreate' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupIntentCreate' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupIntentCreate' description: '' put: operationId: accounts_stripe_create_setup_intent_update description: Action to start a new setup intent. parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountStripeSetupIntentCreate' multipart/form-data: schema: $ref: '#/components/schemas/AccountStripeSetupIntentCreate' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupIntentCreate' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupIntentCreate' description: '' /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: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountStripePaymentMethodDetach' multipart/form-data: schema: $ref: '#/components/schemas/AccountStripePaymentMethodDetach' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripePaymentMethodDetach' application/xlsx; version=2.4.13: 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. This will also return non-attached payment methods (from setup intents for example) parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/AccountStripePaymentMethodGet' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripePaymentMethodGet' description: '' /accounts/{id}/stripe_get_setup_attempt/: get: operationId: accounts_stripe_get_setup_attempt_retrieve description: Fetch a single setup intent parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupAttemptGet' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupAttemptGet' description: '' /accounts/{id}/stripe_get_setup_intent/: get: operationId: accounts_stripe_get_setup_intent_retrieve description: Fetch a single setup intent parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupIntentGet' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupIntentGet' description: '' /accounts/{id}/stripe_payment_methods/: get: operationId: accounts_stripe_payment_methods_retrieve description: |- Fetch all customer payment methods. This includes all attached payment methods, default method_id parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/AccountStripePaymentMethods' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripePaymentMethods' description: '' /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: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountStripePaymentMethodSetDefault' multipart/form-data: schema: $ref: '#/components/schemas/AccountStripePaymentMethodSetDefault' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripePaymentMethodSetDefault' application/xlsx; version=2.4.13: 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: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupIntentsGet' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountStripeSetupIntentsGet' description: '' /accounts/{id}/workers/: get: operationId: accounts_workers_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/AccountUser' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountUser' description: '' post: operationId: accounts_workers_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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/AccountUser' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountUser' multipart/form-data: schema: $ref: '#/components/schemas/AccountUser' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/AccountUser' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/AccountUser' description: '' delete: operationId: accounts_workers_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this account. required: true tags: - accounts security: - tokenAuth: [] responses: '204': description: No response body /addons/: get: operationId: addons_list parameters: - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/PaginatedAddonList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedAddonList' description: '' /addons/{id}/: get: operationId: addons_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Addon' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Addon' description: '' /authenticate/: post: operationId: authenticate_create tags: - authenticate requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AuthToken' multipart/form-data: schema: $ref: '#/components/schemas/AuthToken' application/json: schema: $ref: '#/components/schemas/AuthToken' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthToken' description: '' /billing/customers/: get: operationId: billing_customers_list parameters: - name: account required: false in: query description: account schema: type: string - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer tags: - billing security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedBraintreeCustomerList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedBraintreeCustomerList' description: '' post: operationId: billing_customers_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BraintreeCustomer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BraintreeCustomer' multipart/form-data: schema: $ref: '#/components/schemas/BraintreeCustomer' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' description: '' /billing/customers/{id}/: get: operationId: billing_customers_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this braintree customer. required: true tags: - billing security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' description: '' put: operationId: billing_customers_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this braintree customer. required: true tags: - billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BraintreeCustomer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BraintreeCustomer' multipart/form-data: schema: $ref: '#/components/schemas/BraintreeCustomer' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' description: '' patch: operationId: billing_customers_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this braintree customer. required: true tags: - billing requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedBraintreeCustomer' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedBraintreeCustomer' multipart/form-data: schema: $ref: '#/components/schemas/PatchedBraintreeCustomer' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' description: '' /billing/customers/{id}/client_token/: get: operationId: billing_customers_client_token_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this braintree customer. required: true tags: - billing security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeCustomer' description: '' /billing/invoices/: get: operationId: billing_invoices_list parameters: - name: account required: false in: query description: account schema: type: string - name: billing_method required: false in: query description: billing_method schema: type: string enum: - braintree - invoice - stripe - name: confirmed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: confirmed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: confirmed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: confirmed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: confirmed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: confirmed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: confirmed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: confirmed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: confirmed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: confirmed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at required: false in: query description: created_at schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - 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: state required: false in: query description: state schema: type: string enum: - draft - confirmed - overdue - paid - cancelled tags: - billing security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedInvoiceList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedInvoiceList' description: '' /billing/invoices/{id}/: get: operationId: billing_invoices_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Invoice' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Invoice' description: '' put: operationId: billing_invoices_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Invoice' multipart/form-data: schema: $ref: '#/components/schemas/Invoice' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Invoice' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Invoice' description: '' patch: operationId: billing_invoices_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedInvoice' multipart/form-data: schema: $ref: '#/components/schemas/PatchedInvoice' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Invoice' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Invoice' description: '' /billing/invoices/{id}/mark_as_paid/: post: operationId: billing_invoices_mark_as_paid_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Invoice' multipart/form-data: schema: $ref: '#/components/schemas/Invoice' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Invoice' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Invoice' description: '' /billing/stripe_payments/: get: operationId: billing_stripe_payments_list parameters: - name: billable_account required: false in: query description: billable_account schema: type: string - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: invoice required: false in: query description: invoice 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: state required: false in: query description: state schema: type: string enum: - draft - failed - saved - settled - rejected - retried - cancelled - name: stripe_state required: false in: query description: stripe_state schema: type: string enum: - null - requires_payment_method - requires_confirmation - requires_capture - requires_action - processing - succeeded - canceled tags: - billing security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedStripePaymentList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedStripePaymentList' description: '' /billing/stripe_payments/{id}/: get: operationId: billing_stripe_payments_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/StripePayment' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/StripePayment' description: '' /billing/transactions/: get: operationId: billing_transactions_list parameters: - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: customer required: false in: query description: customer schema: type: string - in: query name: format schema: type: string enum: - json - xlsx - name: invoice__account required: false in: query description: invoice__account 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: state required: false in: query description: state schema: type: string enum: - draft - failed - saved - settled - rejected - voided - refunded - retried - cancelled - imported tags: - billing security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedBraintreeTransactionList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedBraintreeTransactionList' description: '' /billing/transactions/{id}/: get: operationId: billing_transactions_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this braintree transaction. required: true tags: - billing security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeTransaction' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/BraintreeTransaction' description: '' /client_roles/: get: operationId: client_roles_list parameters: - name: account required: false in: query description: account schema: type: string - name: client required: false in: query description: client schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: is_active required: false in: query description: is_active schema: type: string - name: is_manager required: false in: query description: is_manager 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: user required: false in: query description: user schema: type: string tags: - client_roles security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedClientRoleList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedClientRoleList' description: '' post: operationId: client_roles_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - client_roles requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientRole' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ClientRole' multipart/form-data: schema: $ref: '#/components/schemas/ClientRole' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' description: '' /client_roles/{id}/: get: operationId: client_roles_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this client role. required: true tags: - client_roles security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' description: '' put: operationId: client_roles_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ClientRole' multipart/form-data: schema: $ref: '#/components/schemas/ClientRole' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' description: '' patch: operationId: client_roles_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedClientRole' multipart/form-data: schema: $ref: '#/components/schemas/PatchedClientRole' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' description: '' /client_roles/{id}/notify/: post: operationId: client_roles_notify_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ClientRole' multipart/form-data: schema: $ref: '#/components/schemas/ClientRole' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ClientRole' description: '' /clients/: get: operationId: clients_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - 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: slug required: false in: query description: slug schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - clients security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedClientList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedClientList' description: '' post: operationId: clients_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - clients requestBody: content: application/json: schema: $ref: '#/components/schemas/Client' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Client' multipart/form-data: schema: $ref: '#/components/schemas/Client' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Client' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Client' description: '' /clients/{id}/: get: operationId: clients_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Client' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Client' description: '' put: operationId: clients_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Client' multipart/form-data: schema: $ref: '#/components/schemas/Client' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Client' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Client' description: '' patch: operationId: clients_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedClient' multipart/form-data: schema: $ref: '#/components/schemas/PatchedClient' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Client' application/xlsx; version=2.4.13: 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: integer - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/PaginatedConfigurationSerializerV2List' application/xlsx; version=2.4.13: 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: - name: account required: false in: query description: account schema: type: string - name: address__apartment_number required: false in: query description: 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 - name: address__city required: false in: query description: 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 - name: address__country required: false in: query description: 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 - name: address__country_code required: false in: query description: 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 - name: address__formatted_address required: false in: query description: 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__postal_code required: false in: query description: 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 - name: address__state required: false in: query description: 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 - name: address__street required: false in: query description: 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 - name: contact__company required: false in: query description: 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 - name: contact__name required: false in: query description: contact__name schema: type: string - name: contact__notes required: false in: query description: 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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 - name: is_orderer required: false in: query description: is_orderer schema: type: string - name: is_receiver required: false in: query description: is_receiver 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 - name: source required: false in: query description: source schema: type: string - name: sourcecontact__name__icontains required: false in: query schema: type: string - name: sourcecontact__name__iexact required: false in: query schema: type: string - name: sourcecontact__name__iregex required: false in: query schema: type: string - name: sourcecontact__name__istartswith required: false in: query schema: type: string - name: sourcecontact__name__search required: false in: query schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - contact_address_exports security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedContactAddressExportList' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedContactAddressExportList' description: '' /contact_address_import/: get: operationId: contact_address_import_list parameters: - name: account required: false in: query description: account schema: type: string - name: completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: started_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: started_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: started_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: state required: false in: query description: state schema: type: string enum: - pending - started - completed - failed - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - contact_address_import security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedContactAddressBackgroundImportList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedContactAddressBackgroundImportList' description: '' post: operationId: contact_address_import_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - contact_address_import requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactAddressBackgroundImport' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ContactAddressBackgroundImport' multipart/form-data: schema: $ref: '#/components/schemas/ContactAddressBackgroundImport' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddressBackgroundImport' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddressBackgroundImport' description: '' /contact_address_import/{id}/: get: operationId: contact_address_import_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/ContactAddressBackgroundImport' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddressBackgroundImport' description: '' /contact_addresses/: get: operationId: contact_addresses_list parameters: - name: account required: false in: query description: account schema: type: string - name: address__apartment_number required: false in: query description: 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 - name: address__city required: false in: query description: 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 - name: address__country required: false in: query description: 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 - name: address__country_code required: false in: query description: 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 - name: address__formatted_address required: false in: query description: 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__postal_code required: false in: query description: 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 - name: address__state required: false in: query description: 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 - name: address__street required: false in: query description: 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 - name: client required: false in: query description: client schema: type: string - name: contact__company required: false in: query description: 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 - name: contact__name required: false in: query description: 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 - name: contact__notes required: false in: query description: 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: is_orderer required: false in: query description: is_orderer schema: type: string - name: is_receiver required: false in: query description: is_receiver 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 - name: source required: false in: query description: 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - contact_addresses security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedContactAddressList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedContactAddressList' description: '' post: operationId: contact_addresses_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - contact_addresses requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactAddress' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ContactAddress' multipart/form-data: schema: $ref: '#/components/schemas/ContactAddress' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddress' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddress' description: '' /contact_addresses/{id}/: get: operationId: contact_addresses_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/ContactAddress' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddress' description: '' put: operationId: contact_addresses_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ContactAddress' multipart/form-data: schema: $ref: '#/components/schemas/ContactAddress' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddress' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddress' description: '' patch: operationId: contact_addresses_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedContactAddress' multipart/form-data: schema: $ref: '#/components/schemas/PatchedContactAddress' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddress' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ContactAddress' description: '' /devices/: get: operationId: devices_list parameters: - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - 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: user required: false in: query description: user schema: type: string - name: user__account_roles__account required: false in: query description: user__account_roles__account schema: type: string tags: - devices security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedDeviceList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedDeviceList' description: '' post: operationId: devices_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - devices requestBody: content: application/json: schema: $ref: '#/components/schemas/Device' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Device' multipart/form-data: schema: $ref: '#/components/schemas/Device' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Device' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Device' description: '' /devices/{id}/: get: operationId: devices_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this device. required: true tags: - devices security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Device' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Device' description: '' /docs/schema/: get: operationId: docs_schema_retrieve description: |- OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json 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.4.13: schema: type: object additionalProperties: {} application/yaml; version=2.4.13: schema: type: object additionalProperties: {} application/vnd.oai.openapi+json; version=2.4.13: schema: type: object additionalProperties: {} application/json; version=2.4.13: schema: type: object additionalProperties: {} description: '' /documents/: get: operationId: documents_list parameters: - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: integer - name: filename required: false in: query description: 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: format schema: type: string enum: - json - xlsx - name: mimetype required: false in: query description: mimetype schema: type: string - name: order required: false in: query description: order 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 - name: source required: false in: query description: source schema: type: string enum: - web - mobile - integration - name: task required: false in: query description: task schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - documents security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedDocumentList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedDocumentList' description: '' post: operationId: documents_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - documents requestBody: content: application/json: schema: $ref: '#/components/schemas/Document' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Document' multipart/form-data: schema: $ref: '#/components/schemas/Document' security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Document' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Document' description: '' /documents/{id}/: get: operationId: documents_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Document' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Document' description: '' delete: operationId: documents_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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 parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - documents requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentDeleteAction' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DocumentDeleteAction' multipart/form-data: schema: $ref: '#/components/schemas/DocumentDeleteAction' required: true security: - tokenAuth: [] responses: '204': description: No response body /emails/: get: operationId: emails_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: external_id required: false in: query description: external_id schema: type: string - name: external_id__icontains required: false in: query description: external_id__icontains schema: type: string - name: failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - in: query name: format schema: type: string enum: - json - xlsx - name: from_email required: false in: query description: from_email schema: type: string - name: from_email__icontains required: false in: query description: from_email__icontains schema: type: string - name: id required: false in: query description: id schema: type: string - name: message required: false in: query description: message schema: type: string - name: message__icontains required: false in: query description: 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: received_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: received_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: reply_to_email required: false in: query description: reply_to_email schema: type: string - name: reply_to_email__icontains required: false in: query description: reply_to_email__icontains schema: type: string - name: search required: false in: query description: A search term. schema: type: string - name: sent_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: sent_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: sent_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: state required: false in: query description: state schema: type: string enum: - queued - over_quota - sent - failed - received - name: state__in required: false in: query description: state__in schema: type: string - name: subject required: false in: query description: subject schema: type: string - name: subject__icontains required: false in: query description: subject__icontains schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - emails security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedEmailList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedEmailList' description: '' post: operationId: emails_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - emails requestBody: content: application/json: schema: $ref: '#/components/schemas/Email' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Email' multipart/form-data: schema: $ref: '#/components/schemas/Email' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Email' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Email' description: '' /emails/{id}/: get: operationId: emails_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Email' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Email' description: '' put: operationId: emails_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this email. required: true tags: - emails requestBody: content: application/json: schema: $ref: '#/components/schemas/Email' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Email' multipart/form-data: schema: $ref: '#/components/schemas/Email' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Email' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Email' description: '' patch: operationId: emails_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this email. required: true tags: - emails requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEmail' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedEmail' multipart/form-data: schema: $ref: '#/components/schemas/PatchedEmail' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Email' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Email' description: '' delete: operationId: emails_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this email. required: true tags: - emails security: - tokenAuth: [] responses: '204': description: No response body /emails/{id}/resend/: post: operationId: emails_resend_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this email. required: true tags: - emails requestBody: content: application/json: schema: $ref: '#/components/schemas/Email' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Email' multipart/form-data: schema: $ref: '#/components/schemas/Email' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Email' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Email' description: '' /exports/: get: operationId: exports_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - exports security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedExportList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedExportList' description: '' post: operationId: exports_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - exports requestBody: content: application/json: schema: $ref: '#/components/schemas/Export' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Export' multipart/form-data: schema: $ref: '#/components/schemas/Export' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Export' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Export' description: '' /exports/{id}/: get: operationId: exports_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Export' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Export' description: '' put: operationId: exports_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Export' multipart/form-data: schema: $ref: '#/components/schemas/Export' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Export' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Export' description: '' patch: operationId: exports_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedExport' multipart/form-data: schema: $ref: '#/components/schemas/PatchedExport' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Export' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Export' description: '' delete: operationId: exports_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: integer - name: filename required: false in: query description: 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: format schema: type: string enum: - json - xlsx - 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: source required: false in: query description: source schema: type: string enum: - web - mobile - integration - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - file_uploads security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedS3FileUploadList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedS3FileUploadList' description: '' post: operationId: file_uploads_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - file_uploads requestBody: content: application/json: schema: $ref: '#/components/schemas/S3FileUpload' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/S3FileUpload' multipart/form-data: schema: $ref: '#/components/schemas/S3FileUpload' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/S3FileUpload' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/S3FileUpload' description: '' /file_uploads/{id}/: get: operationId: file_uploads_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/S3FileUpload' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/S3FileUpload' description: '' /formrules/: get: operationId: formrules_list parameters: - name: account required: false in: query description: account schema: type: string - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - 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: - formrules security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedFormRuleList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedFormRuleList' description: '' post: operationId: formrules_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - formrules requestBody: content: application/json: schema: $ref: '#/components/schemas/FormRule' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FormRule' multipart/form-data: schema: $ref: '#/components/schemas/FormRule' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/FormRule' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/FormRule' description: '' /formrules/{id}/: get: operationId: formrules_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this form rule. required: true tags: - formrules security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/FormRule' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/FormRule' description: '' put: operationId: formrules_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this form rule. required: true tags: - formrules requestBody: content: application/json: schema: $ref: '#/components/schemas/FormRule' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FormRule' multipart/form-data: schema: $ref: '#/components/schemas/FormRule' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/FormRule' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/FormRule' description: '' patch: operationId: formrules_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this form rule. required: true tags: - formrules requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedFormRule' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedFormRule' multipart/form-data: schema: $ref: '#/components/schemas/PatchedFormRule' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/FormRule' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/FormRule' description: '' delete: operationId: formrules_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this form rule. required: true tags: - formrules security: - tokenAuth: [] responses: '204': description: No response body /integrations/: post: operationId: integrations_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - integrations requestBody: content: application/json: schema: $ref: '#/components/schemas/IntegrationRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/IntegrationRequest' multipart/form-data: schema: $ref: '#/components/schemas/IntegrationRequest' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/IntegrationRequest' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/IntegrationRequest' description: '' /metafields/: get: operationId: metafields_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: is_editable required: false in: query description: is_editable schema: type: string - name: is_editable_assignee required: false in: query description: is_editable_assignee schema: type: string - name: is_persistent required: false in: query description: is_persistent schema: type: string - name: is_required required: false in: query description: is_required schema: type: string - name: is_searchable required: false in: query description: is_searchable schema: type: string - name: key required: false in: query description: key schema: type: string - name: label required: false in: query description: label schema: type: string - name: namespace required: false in: query description: 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 - name: show_in_detail_view required: false in: query description: show_in_detail_view schema: type: string - name: show_in_list_view required: false in: query description: show_in_list_view schema: type: string - name: show_in_mobile_app required: false in: query description: show_in_mobile_app schema: type: string - name: show_in_pod required: false in: query description: show_in_pod schema: type: string - name: show_when_task_type_assignment required: false in: query description: show_when_task_type_assignment schema: type: string - name: show_when_task_type_drop_off required: false in: query description: show_when_task_type_drop_off schema: type: string - name: show_when_task_type_pick_up required: false in: query description: show_when_task_type_pick_up schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: value_type required: false in: query description: value_type schema: type: string enum: - string - integer - decimal - choice tags: - metafields security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedMetafieldList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedMetafieldList' description: '' post: operationId: metafields_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - metafields requestBody: content: application/json: schema: $ref: '#/components/schemas/Metafield' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Metafield' multipart/form-data: schema: $ref: '#/components/schemas/Metafield' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Metafield' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Metafield' description: '' /metafields/{id}/: get: operationId: metafields_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Metafield' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Metafield' description: '' put: operationId: metafields_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Metafield' multipart/form-data: schema: $ref: '#/components/schemas/Metafield' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Metafield' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Metafield' description: '' patch: operationId: metafields_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedMetafield' multipart/form-data: schema: $ref: '#/components/schemas/PatchedMetafield' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Metafield' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Metafield' description: '' delete: operationId: metafields_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: event required: false in: query description: event schema: type: string enum: - create - assign - unassign - reject - accept - unaccept - transit - activate - complete - fail - cancel - assignee_near - assignee_away - updated - in: query name: format schema: type: string enum: - json - xlsx - name: is_active required: false in: query description: is_active schema: type: string - name: name required: false in: query description: 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 - name: recipient required: false in: query description: recipient schema: type: string enum: - account - assignee - orderer - contact - client - name: search required: false in: query description: A search term. schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: via_app required: false in: query description: via_app schema: type: string - name: via_email required: false in: query description: via_email schema: type: string - name: via_sms required: false in: query description: via_sms schema: type: string tags: - notification_templates security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' post: operationId: notification_templates_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - notification_templates requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/NotificationTemplate' multipart/form-data: schema: $ref: '#/components/schemas/NotificationTemplate' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/NotificationTemplate' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' /notification_templates/{id}/: get: operationId: notification_templates_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/NotificationTemplate' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' put: operationId: notification_templates_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/NotificationTemplate' multipart/form-data: schema: $ref: '#/components/schemas/NotificationTemplate' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/NotificationTemplate' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' patch: operationId: notification_templates_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedNotificationTemplate' multipart/form-data: schema: $ref: '#/components/schemas/PatchedNotificationTemplate' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/NotificationTemplate' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' delete: operationId: notification_templates_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RenderRequest' multipart/form-data: schema: $ref: '#/components/schemas/RenderRequest' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/RenderRequest' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/RenderRequest' description: '' /notifications/: get: operationId: notifications_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: event required: false in: query description: event schema: type: string enum: - create - assign - unassign - reject - accept - unaccept - transit - activate - complete - fail - cancel - assignee_near - assignee_away - updated - in: query name: format schema: type: string enum: - json - xlsx - 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: recipient required: false in: query description: recipient schema: type: string enum: - account - assignee - orderer - contact - client - name: search required: false in: query description: A search term. schema: type: string - name: sent_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: sent_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: sent_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: task required: false in: query description: task schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: via_app required: false in: query description: via_app schema: type: string - name: via_email required: false in: query description: via_email schema: type: string - name: via_sms required: false in: query description: via_sms schema: type: string tags: - notifications security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedNotificationList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedNotificationList' description: '' post: operationId: notifications_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - notifications requestBody: content: application/json: schema: $ref: '#/components/schemas/Notification' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Notification' multipart/form-data: schema: $ref: '#/components/schemas/Notification' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Notification' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Notification' description: '' /notifications/{id}/: get: operationId: notifications_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this notification. required: true tags: - notifications security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Notification' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Notification' description: '' /orders/: get: operationId: orders_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: external_id required: false in: query description: external_id schema: type: string - name: id required: false in: query description: id 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: reference required: false in: query description: reference schema: type: string - name: search required: false in: query description: A search term. schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - orders security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedOrderSerializerV2List' description: '' post: operationId: orders_create tags: - orders requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderSerializerV2' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrderSerializerV2' multipart/form-data: schema: $ref: '#/components/schemas/OrderSerializerV2' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: 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 tags: - orders security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrderSerializerV2' multipart/form-data: schema: $ref: '#/components/schemas/OrderSerializerV2' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedOrderSerializerV2' multipart/form-data: schema: $ref: '#/components/schemas/PatchedOrderSerializerV2' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/OrderSerializerV2' description: '' /password_change/: post: operationId: password_change_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - password_change requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordChange' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PasswordChange' multipart/form-data: schema: $ref: '#/components/schemas/PasswordChange' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PasswordChange' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PasswordChange' description: '' /password_reset/: post: operationId: password_reset_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - password_reset requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordReset' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PasswordReset' multipart/form-data: schema: $ref: '#/components/schemas/PasswordReset' required: true responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PasswordReset' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PasswordReset' description: '' /password_reset_confirm/: post: operationId: password_reset_confirm_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - password_reset_confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordResetConfirm' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PasswordResetConfirm' multipart/form-data: schema: $ref: '#/components/schemas/PasswordResetConfirm' required: true responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PasswordResetConfirm' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PasswordResetConfirm' description: '' /push_notifications/: get: operationId: push_notifications_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: event required: false in: query description: event schema: type: string enum: - create - assign - unassign - reject - accept - unaccept - transit - activate - complete - fail - cancel - assignee_near - assignee_away - updated - name: event__in required: false in: query description: event__in schema: type: string - name: external_id required: false in: query description: external_id schema: type: string - name: external_id__icontains required: false in: query description: external_id__icontains schema: type: string - name: failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - in: query name: format schema: type: string enum: - json - xlsx - name: id required: false in: query description: id schema: type: string - name: message required: false in: query description: message schema: type: string - name: message__icontains required: false in: query description: 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: pending_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: pending_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: pending_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: pending_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: pending_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: pending_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: pending_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: pending_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: pending_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: search required: false in: query description: A search term. schema: type: string - name: state required: false in: query description: state schema: type: string enum: - queued - pending - failed - sent - name: state__in required: false in: query description: state__in schema: type: string - name: subject required: false in: query description: subject schema: type: string - name: subject__icontains required: false in: query description: subject__icontains schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - push_notifications security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedPushNotificationList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedPushNotificationList' description: '' post: operationId: push_notifications_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - push_notifications requestBody: content: application/json: schema: $ref: '#/components/schemas/PushNotification' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PushNotification' multipart/form-data: schema: $ref: '#/components/schemas/PushNotification' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PushNotification' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PushNotification' description: '' /push_notifications/{id}/: get: operationId: push_notifications_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/PushNotification' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PushNotification' description: '' put: operationId: push_notifications_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this push notification. required: true tags: - push_notifications requestBody: content: application/json: schema: $ref: '#/components/schemas/PushNotification' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PushNotification' multipart/form-data: schema: $ref: '#/components/schemas/PushNotification' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PushNotification' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PushNotification' description: '' patch: operationId: push_notifications_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this push notification. required: true tags: - push_notifications requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPushNotification' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPushNotification' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPushNotification' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PushNotification' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PushNotification' description: '' delete: operationId: push_notifications_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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: '204': description: No response body /push_notifications/{id}/resend/: post: operationId: push_notifications_resend_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this push notification. required: true tags: - push_notifications requestBody: content: application/json: schema: $ref: '#/components/schemas/PushNotification' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PushNotification' multipart/form-data: schema: $ref: '#/components/schemas/PushNotification' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PushNotification' application/xlsx; version=2.4.13: 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: integer - name: is_active required: false in: query description: is_active schema: type: string - name: last_errored_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_errored_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_errored_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_recurred_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_recurred_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_scheduled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_scheduled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: next_scheduled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: next_scheduled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order required: false in: query description: Filter by order and previous orders example: 4c25e31f-3a5a-4d52-8531-20c3e8549df0 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 - name: search required: false in: query description: A search term. schema: type: string - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - recurrences security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedRecurrenceList' description: '' post: operationId: recurrences_create tags: - recurrences requestBody: content: application/json: schema: $ref: '#/components/schemas/Recurrence' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Recurrence' multipart/form-data: schema: $ref: '#/components/schemas/Recurrence' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: 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 tags: - recurrences security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Recurrence' multipart/form-data: schema: $ref: '#/components/schemas/Recurrence' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedRecurrence' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRecurrence' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Recurrence' description: '' /register/: post: operationId: register_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - register requestBody: content: application/json: schema: $ref: '#/components/schemas/Registration' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Registration' multipart/form-data: schema: $ref: '#/components/schemas/Registration' required: true responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Registration' application/xlsx; version=2.4.13: 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: 16a0a96b-90cc-4b73-8a00-57ac8c8393c0,4b6cf9e2-1dbb-4f50-84c8-d0c188be7154 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: format schema: type: string enum: - json - xlsx - in: query name: timezone schema: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - 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/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - 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/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Costa_Rica - 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/Fort_Nelson - America/Fortaleza - America/Glace_Bay - 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/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - 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_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - 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/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - 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/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - 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/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - 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/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - 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/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - 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/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC tags: - reports security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TasksStatesCountResponse' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TasksStatesCountResponse' description: '' /reviews/: get: operationId: reviews_list parameters: - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - 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: tracker required: false in: query description: tracker schema: type: string tags: - reviews security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedReviewList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedReviewList' description: '' post: operationId: reviews_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - reviews requestBody: content: application/json: schema: $ref: '#/components/schemas/Review' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Review' multipart/form-data: schema: $ref: '#/components/schemas/Review' required: true security: - tokenAuth: [] - {} responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Review' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Review' description: '' /reviews/{id}/: get: operationId: reviews_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this review. required: true tags: - reviews security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Review' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Review' description: '' /route_optimizations/: get: operationId: route_optimizations_list parameters: - name: account required: false in: query description: account schema: type: string - name: assignees__id__in required: false in: query description: assignees__id__in schema: type: string - name: commited_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: commited_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: commited_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: commited_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: commited_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: commited_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: commited_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: commited_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: commited_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: commited_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - in: query name: format schema: type: string enum: - json - xml - name: id required: false in: query description: id schema: type: string - name: objective required: false in: query description: objective schema: type: string enum: - vehicles - transport_time - completion_time - name: objective__in required: false in: query description: objective__in 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: ready_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: ready_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: ready_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: ready_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: ready_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: ready_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: ready_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: ready_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: ready_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: ready_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: started_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: started_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: state required: false in: query description: state schema: type: string enum: - pending - started - ready - completed - over_quota - failed - name: state__in required: false in: query description: state__in schema: type: string - name: total_distance__gt required: false in: query description: total_distance__gt schema: type: string - name: total_distance__gte required: false in: query description: total_distance__gte schema: type: string - name: total_distance__lt required: false in: query description: total_distance__lt schema: type: string - name: total_distance__lte required: false in: query description: total_distance__lte schema: type: string - name: total_duration__gt required: false in: query description: total_duration__gt schema: type: string - name: total_duration__gte required: false in: query description: total_duration__gte schema: type: string - name: total_duration__lt required: false in: query description: total_duration__lt schema: type: string - name: total_duration__lte required: false in: query description: total_duration__lte schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - route_optimizations security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedRouteOptimizationSerializerV2List' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedRouteOptimizationSerializerV2List' description: '' post: operationId: route_optimizations_create parameters: - in: query name: format schema: type: string enum: - json - xml tags: - route_optimizations requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' description: '' /route_optimizations/{id}/: get: operationId: route_optimizations_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - 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': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' description: '' /route_optimizations/{id}/commit/: post: operationId: route_optimizations_commit_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this route optimization. required: true tags: - route_optimizations requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' description: '' /route_optimizations/{id}/results/: get: operationId: route_optimizations_results_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - 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': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' description: '' /route_optimizations/{id}/routes/: get: operationId: route_optimizations_routes_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - 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': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' description: '' post: operationId: route_optimizations_routes_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this route optimization. required: true tags: - route_optimizations requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' description: '' /route_optimizations/{id}/schedule/: post: operationId: route_optimizations_schedule_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this route optimization. required: true tags: - route_optimizations requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/RouteOptimizationSerializerV2' description: '' /routes/: get: operationId: routes_list parameters: - name: account required: false in: query description: account schema: type: string - name: assignee required: false in: query description: assignee schema: type: string - name: code required: false in: query description: code schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - routes security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedRouteList' description: '' post: operationId: routes_create tags: - routes requestBody: content: application/json: schema: $ref: '#/components/schemas/Route' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Route' multipart/form-data: schema: $ref: '#/components/schemas/Route' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: 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.4.13: 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Route' multipart/form-data: schema: $ref: '#/components/schemas/Route' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedRoute' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRoute' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: 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 /scenes/dashboard/: get: operationId: scenes_dashboard_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: address__apartment_number required: false in: query description: address__apartment_number schema: type: string - name: address__apartment_number__icontains required: false in: query description: address__apartment_number__icontains schema: type: string - name: address__apartment_number__in required: false in: query description: address__apartment_number__in schema: type: string - name: address__apartment_number__iregex required: false in: query description: address__apartment_number__iregex schema: type: string - name: address__apartment_number__istartswith required: false in: query description: address__apartment_number__istartswith schema: type: string - name: address__apartment_number__search required: false in: query description: address__apartment_number__search schema: type: string - name: address__city required: false in: query description: address__city schema: type: string - name: address__city__icontains required: false in: query description: address__city__icontains schema: type: string - name: address__city__in required: false in: query description: address__city__in schema: type: string - name: address__city__iregex required: false in: query description: address__city__iregex schema: type: string - name: address__city__istartswith required: false in: query description: address__city__istartswith schema: type: string - name: address__city__search required: false in: query description: address__city__search schema: type: string - name: address__country required: false in: query description: address__country schema: type: string - name: address__country__icontains required: false in: query description: address__country__icontains schema: type: string - name: address__country__in required: false in: query description: address__country__in schema: type: string - name: address__country__iregex required: false in: query description: address__country__iregex schema: type: string - name: address__country__istartswith required: false in: query description: address__country__istartswith schema: type: string - name: address__country__search required: false in: query description: address__country__search schema: type: string - name: address__country_code required: false in: query description: address__country_code schema: type: string - name: address__country_code__icontains required: false in: query description: address__country_code__icontains schema: type: string - name: address__country_code__in required: false in: query description: address__country_code__in schema: type: string - name: address__country_code__iregex required: false in: query description: address__country_code__iregex schema: type: string - name: address__country_code__istartswith required: false in: query description: address__country_code__istartswith schema: type: string - name: address__country_code__search required: false in: query description: address__country_code__search schema: type: string - name: address__formatted_address required: false in: query description: address__formatted_address schema: type: string - name: address__formatted_address__icontains required: false in: query description: address__formatted_address__icontains schema: type: string - name: address__formatted_address__in required: false in: query description: address__formatted_address__in schema: type: string - name: address__formatted_address__iregex required: false in: query description: address__formatted_address__iregex schema: type: string - name: address__formatted_address__istartswith required: false in: query description: address__formatted_address__istartswith schema: type: string - name: address__formatted_address__search required: false in: query description: address__formatted_address__search schema: type: string - name: address__geocode_failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocode_failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocode_failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocoded_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocoded_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__google_place_id required: false in: query description: address__google_place_id schema: type: string - name: address__google_place_id__icontains required: false in: query description: address__google_place_id__icontains schema: type: string - name: address__google_place_id__in required: false in: query description: address__google_place_id__in schema: type: string - name: address__google_place_id__iregex required: false in: query description: address__google_place_id__iregex schema: type: string - name: address__google_place_id__istartswith required: false in: query description: address__google_place_id__istartswith schema: type: string - name: address__google_place_id__search required: false in: query description: address__google_place_id__search schema: type: string - name: address__house_number required: false in: query description: address__house_number schema: type: string - name: address__house_number__icontains required: false in: query description: address__house_number__icontains schema: type: string - name: address__house_number__in required: false in: query description: address__house_number__in schema: type: string - name: address__house_number__iregex required: false in: query description: address__house_number__iregex schema: type: string - name: address__house_number__istartswith required: false in: query description: address__house_number__istartswith schema: type: string - name: address__house_number__search required: false in: query description: address__house_number__search schema: type: string - name: address__point_of_interest required: false in: query description: address__point_of_interest schema: type: string - name: address__point_of_interest__icontains required: false in: query description: address__point_of_interest__icontains schema: type: string - name: address__point_of_interest__in required: false in: query description: address__point_of_interest__in schema: type: string - name: address__point_of_interest__iregex required: false in: query description: address__point_of_interest__iregex schema: type: string - name: address__point_of_interest__istartswith required: false in: query description: address__point_of_interest__istartswith schema: type: string - name: address__point_of_interest__search required: false in: query description: address__point_of_interest__search schema: type: string - name: address__postal_code required: false in: query description: address__postal_code schema: type: string - name: address__postal_code__icontains required: false in: query description: address__postal_code__icontains schema: type: string - name: address__postal_code__in required: false in: query description: address__postal_code__in schema: type: string - name: address__postal_code__iregex required: false in: query description: address__postal_code__iregex schema: type: string - name: address__postal_code__istartswith required: false in: query description: address__postal_code__istartswith schema: type: string - name: address__postal_code__search required: false in: query description: address__postal_code__search schema: type: string - name: address__raw_address required: false in: query description: address__raw_address schema: type: string - name: address__raw_address__icontains required: false in: query description: address__raw_address__icontains schema: type: string - name: address__raw_address__in required: false in: query description: address__raw_address__in schema: type: string - name: address__raw_address__iregex required: false in: query description: address__raw_address__iregex schema: type: string - name: address__raw_address__istartswith required: false in: query description: address__raw_address__istartswith schema: type: string - name: address__raw_address__search required: false in: query description: address__raw_address__search schema: type: string - name: address__state required: false in: query description: address__state schema: type: string - name: address__state__icontains required: false in: query description: address__state__icontains schema: type: string - name: address__state__in required: false in: query description: address__state__in schema: type: string - name: address__state__iregex required: false in: query description: address__state__iregex schema: type: string - name: address__state__istartswith required: false in: query description: address__state__istartswith schema: type: string - name: address__state__search required: false in: query description: address__state__search schema: type: string - name: address__street required: false in: query description: address__street schema: type: string - name: address__street__icontains required: false in: query description: address__street__icontains schema: type: string - name: address__street__in required: false in: query description: address__street__in schema: type: string - name: address__street__iregex required: false in: query description: address__street__iregex schema: type: string - name: address__street__istartswith required: false in: query description: address__street__istartswith schema: type: string - name: address__street__search required: false in: query description: 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 - name: address_id required: false in: query description: address_id schema: type: string - name: address_id__in required: false in: query description: address_id__in schema: type: string - name: address_id__isnull required: false in: query description: address_id__isnull schema: type: string - name: assignee required: false in: query schema: type: string format: uuid - name: assignee__email required: false in: query description: assignee__email schema: type: string - name: assignee__email__icontains required: false in: query description: assignee__email__icontains schema: type: string - name: assignee__email__iregex required: false in: query description: assignee__email__iregex schema: type: string - name: assignee__email__isnull required: false in: query description: assignee__email__isnull schema: type: string - name: assignee__email__istartswith required: false in: query description: assignee__email__istartswith schema: type: string - name: assignee__email__search required: false in: query description: assignee__email__search schema: type: string - name: assignee__first_name required: false in: query description: assignee__first_name schema: type: string - name: assignee__first_name__icontains required: false in: query description: assignee__first_name__icontains schema: type: string - name: assignee__first_name__iregex required: false in: query description: assignee__first_name__iregex schema: type: string - name: assignee__first_name__isnull required: false in: query description: assignee__first_name__isnull schema: type: string - name: assignee__first_name__istartswith required: false in: query description: assignee__first_name__istartswith schema: type: string - name: assignee__first_name__search required: false in: query description: assignee__first_name__search schema: type: string - name: assignee__in required: false in: query description: comma separated value schema: type: string - name: assignee__last_name required: false in: query description: assignee__last_name schema: type: string - name: assignee__last_name__icontains required: false in: query description: assignee__last_name__icontains schema: type: string - name: assignee__last_name__iregex required: false in: query description: assignee__last_name__iregex schema: type: string - name: assignee__last_name__isnull required: false in: query description: assignee__last_name__isnull schema: type: string - name: assignee__last_name__istartswith required: false in: query description: assignee__last_name__istartswith schema: type: string - name: assignee__last_name__search required: false in: query description: assignee__last_name__search schema: type: string - name: assignee__phone required: false in: query description: assignee__phone schema: type: string - name: assignee__phone__icontains required: false in: query description: assignee__phone__icontains schema: type: string - name: assignee__phone__iregex required: false in: query description: assignee__phone__iregex schema: type: string - name: assignee__phone__isnull required: false in: query description: assignee__phone__isnull schema: type: string - name: assignee__phone__istartswith required: false in: query description: assignee__phone__istartswith schema: type: string - name: assignee__phone__search required: false in: query description: assignee__phone__search schema: type: string - name: assignee_id required: false in: query description: assignee_id schema: type: string - name: assignee_id__in required: false in: query description: assignee_id__in schema: type: string - name: assignee_id__isnull required: false in: query description: assignee_id__isnull schema: type: string - name: assignee_proximity required: false in: query description: assignee_proximity schema: type: string enum: - away - near - name: assignee_proximity__in required: false in: query description: assignee_proximity__in schema: type: string - 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: cancelled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: cancelled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: cancelled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: category required: false in: query description: category schema: type: string enum: - assignment - pick_up - drop_off - warehouse - name: category__in required: false in: query description: category__in schema: type: string - name: complete_after__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: contact__company__icontains required: false in: query description: contact__company__icontains schema: type: string - name: contact__company__in required: false in: query description: contact__company__in schema: type: string - name: contact__company__iregex required: false in: query description: contact__company__iregex schema: type: string - name: contact__company__istartswith required: false in: query description: contact__company__istartswith schema: type: string - name: contact__company__search required: false in: query description: contact__company__search schema: type: string - name: contact__email required: false in: query description: contact__email schema: type: string - name: contact__email__icontains required: false in: query description: contact__email__icontains schema: type: string - name: contact__email__in required: false in: query description: contact__email__in schema: type: string - name: contact__email__iregex required: false in: query description: contact__email__iregex schema: type: string - name: contact__email__istartswith required: false in: query description: contact__email__istartswith schema: type: string - name: contact__email__search required: false in: query description: 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 - name: contact__name required: false in: query description: contact__name schema: type: string - name: contact__name__icontains required: false in: query description: contact__name__icontains schema: type: string - name: contact__name__in required: false in: query description: contact__name__in schema: type: string - name: contact__name__iregex required: false in: query description: contact__name__iregex schema: type: string - name: contact__name__istartswith required: false in: query description: contact__name__istartswith schema: type: string - name: contact__name__search required: false in: query description: contact__name__search schema: type: string - name: contact__notes required: false in: query description: contact__notes schema: type: string - name: contact__notes__icontains required: false in: query description: contact__notes__icontains schema: type: string - name: contact__notes__in required: false in: query description: contact__notes__in schema: type: string - name: contact__notes__iregex required: false in: query description: contact__notes__iregex schema: type: string - name: contact__notes__istartswith required: false in: query description: contact__notes__istartswith schema: type: string - name: contact__notes__search required: false in: query description: contact__notes__search schema: type: string - name: contact__phone required: false in: query description: contact__phone schema: type: string - name: contact__phone__icontains required: false in: query description: contact__phone__icontains schema: type: string - name: contact__phone__in required: false in: query description: contact__phone__in schema: type: string - name: contact__phone__iregex required: false in: query description: contact__phone__iregex schema: type: string - name: contact__phone__istartswith required: false in: query description: contact__phone__istartswith schema: type: string - name: contact__phone__search required: false in: query description: 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_data required: false in: query description: Django ORM lookups can be used. Metafield `is_searchable` must be True. schema: type: string - name: contact_id required: false in: query description: contact_id schema: type: string - name: contact_id__in required: false in: query description: contact_id__in schema: type: string - name: contact_id__isnull required: false in: query description: contact_id__isnull schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_by required: false in: query description: created_by schema: type: string - name: created_by__in required: false in: query description: created_by__in schema: type: string - name: created_by__isnull required: false in: query description: created_by__isnull schema: type: string - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: description required: false in: query description: description schema: type: string - name: description__icontains required: false in: query description: description__icontains schema: type: string - name: description__iregex required: false in: query description: description__iregex schema: type: string - name: description__istartswith required: false in: query description: description__istartswith schema: type: string - name: description__search required: false in: query description: description__search schema: type: string - name: duration required: false in: query description: duration schema: type: string - name: duration__gt required: false in: query description: duration__gt schema: type: string - name: duration__gte required: false in: query description: duration__gte schema: type: string - name: duration__lt required: false in: query description: duration__lt schema: type: string - name: duration__lte required: false in: query description: duration__lte schema: type: string - name: external_id required: false in: query description: external_id schema: type: string - name: external_id__icontains required: false in: query description: external_id__icontains schema: type: string - name: external_id__in required: false in: query description: external_id__in schema: type: string - name: external_id__iregex required: false in: query description: external_id__iregex schema: type: string - name: external_id__isnull required: false in: query description: external_id__isnull schema: type: string - name: external_id__istartswith required: false in: query description: external_id__istartswith schema: type: string - name: external_id__search required: false in: query description: external_id__search schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: id required: false in: query description: id schema: type: string - name: id__in required: false in: query description: id__in schema: type: string - name: is_optimal required: false in: query description: is_optimal schema: type: string - name: is_optimal__isnull required: false in: query description: is_optimal__isnull schema: type: string - name: metadata__accepted_distance required: false in: query description: metadata__accepted_distance schema: type: string - name: metadata__accepted_distance__gt required: false in: query description: metadata__accepted_distance__gt schema: type: string - name: metadata__accepted_distance__gte required: false in: query description: metadata__accepted_distance__gte schema: type: string - name: metadata__accepted_distance__lt required: false in: query description: metadata__accepted_distance__lt schema: type: string - name: metadata__accepted_distance__lte required: false in: query description: metadata__accepted_distance__lte schema: type: string - name: metadata__accepted_duration required: false in: query description: metadata__accepted_duration schema: type: string - name: metadata__accepted_duration__gt required: false in: query description: metadata__accepted_duration__gt schema: type: string - name: metadata__accepted_duration__gte required: false in: query description: metadata__accepted_duration__gte schema: type: string - name: metadata__accepted_duration__lt required: false in: query description: metadata__accepted_duration__lt schema: type: string - name: metadata__accepted_duration__lte required: false in: query description: metadata__accepted_duration__lte schema: type: string - name: metadata__active_distance required: false in: query description: metadata__active_distance schema: type: string - name: metadata__active_distance__gt required: false in: query description: metadata__active_distance__gt schema: type: string - name: metadata__active_distance__gte required: false in: query description: metadata__active_distance__gte schema: type: string - name: metadata__active_distance__lt required: false in: query description: metadata__active_distance__lt schema: type: string - name: metadata__active_distance__lte required: false in: query description: metadata__active_distance__lte schema: type: string - name: metadata__active_duration required: false in: query description: metadata__active_duration schema: type: string - name: metadata__active_duration__gt required: false in: query description: metadata__active_duration__gt schema: type: string - name: metadata__active_duration__gte required: false in: query description: metadata__active_duration__gte schema: type: string - name: metadata__active_duration__lt required: false in: query description: metadata__active_duration__lt schema: type: string - name: metadata__active_duration__lte required: false in: query description: metadata__active_duration__lte schema: type: string - name: metadata__assigned_distance required: false in: query description: metadata__assigned_distance schema: type: string - name: metadata__assigned_distance__gt required: false in: query description: metadata__assigned_distance__gt schema: type: string - name: metadata__assigned_distance__gte required: false in: query description: metadata__assigned_distance__gte schema: type: string - name: metadata__assigned_distance__lt required: false in: query description: metadata__assigned_distance__lt schema: type: string - name: metadata__assigned_distance__lte required: false in: query description: metadata__assigned_distance__lte schema: type: string - name: metadata__assigned_duration required: false in: query description: metadata__assigned_duration schema: type: string - name: metadata__assigned_duration__gt required: false in: query description: metadata__assigned_duration__gt schema: type: string - name: metadata__assigned_duration__gte required: false in: query description: metadata__assigned_duration__gte schema: type: string - name: metadata__assigned_duration__lt required: false in: query description: metadata__assigned_duration__lt schema: type: string - name: metadata__assigned_duration__lte required: false in: query description: metadata__assigned_duration__lte schema: type: string - name: metadata__cancelled_distance required: false in: query description: metadata__cancelled_distance schema: type: string - name: metadata__cancelled_distance__gt required: false in: query description: metadata__cancelled_distance__gt schema: type: string - name: metadata__cancelled_distance__gte required: false in: query description: metadata__cancelled_distance__gte schema: type: string - name: metadata__cancelled_distance__lt required: false in: query description: metadata__cancelled_distance__lt schema: type: string - name: metadata__cancelled_distance__lte required: false in: query description: metadata__cancelled_distance__lte schema: type: string - name: metadata__cancelled_duration required: false in: query description: metadata__cancelled_duration schema: type: string - name: metadata__cancelled_duration__gt required: false in: query description: metadata__cancelled_duration__gt schema: type: string - name: metadata__cancelled_duration__gte required: false in: query description: metadata__cancelled_duration__gte schema: type: string - name: metadata__cancelled_duration__lt required: false in: query description: metadata__cancelled_duration__lt schema: type: string - name: metadata__cancelled_duration__lte required: false in: query description: metadata__cancelled_duration__lte schema: type: string - name: metadata__completed_distance required: false in: query description: metadata__completed_distance schema: type: string - name: metadata__completed_distance__gt required: false in: query description: metadata__completed_distance__gt schema: type: string - name: metadata__completed_distance__gte required: false in: query description: metadata__completed_distance__gte schema: type: string - name: metadata__completed_distance__lt required: false in: query description: metadata__completed_distance__lt schema: type: string - name: metadata__completed_distance__lte required: false in: query description: metadata__completed_distance__lte schema: type: string - name: metadata__completed_duration required: false in: query description: metadata__completed_duration schema: type: string - name: metadata__completed_duration__gt required: false in: query description: metadata__completed_duration__gt schema: type: string - name: metadata__completed_duration__gte required: false in: query description: metadata__completed_duration__gte schema: type: string - name: metadata__completed_duration__lt required: false in: query description: metadata__completed_duration__lt schema: type: string - name: metadata__completed_duration__lte required: false in: query description: metadata__completed_duration__lte schema: type: string - name: metadata__documents_count required: false in: query description: metadata__documents_count schema: type: string - name: metadata__documents_count__gt required: false in: query description: metadata__documents_count__gt schema: type: string - name: metadata__documents_count__gte required: false in: query description: metadata__documents_count__gte schema: type: string - name: metadata__documents_count__lt required: false in: query description: metadata__documents_count__lt schema: type: string - name: metadata__documents_count__lte required: false in: query description: metadata__documents_count__lte schema: type: string - name: metadata__events_count required: false in: query description: metadata__events_count schema: type: string - name: metadata__events_count__gt required: false in: query description: metadata__events_count__gt schema: type: string - name: metadata__events_count__gte required: false in: query description: metadata__events_count__gte schema: type: string - name: metadata__events_count__lt required: false in: query description: metadata__events_count__lt schema: type: string - name: metadata__events_count__lte required: false in: query description: metadata__events_count__lte schema: type: string - name: metadata__failed_distance required: false in: query description: metadata__failed_distance schema: type: string - name: metadata__failed_distance__gt required: false in: query description: metadata__failed_distance__gt schema: type: string - name: metadata__failed_distance__gte required: false in: query description: metadata__failed_distance__gte schema: type: string - name: metadata__failed_distance__lt required: false in: query description: metadata__failed_distance__lt schema: type: string - name: metadata__failed_distance__lte required: false in: query description: metadata__failed_distance__lte schema: type: string - name: metadata__failed_duration required: false in: query description: metadata__failed_duration schema: type: string - name: metadata__failed_duration__gt required: false in: query description: metadata__failed_duration__gt schema: type: string - name: metadata__failed_duration__gte required: false in: query description: metadata__failed_duration__gte schema: type: string - name: metadata__failed_duration__lt required: false in: query description: metadata__failed_duration__lt schema: type: string - name: metadata__failed_duration__lte required: false in: query description: metadata__failed_duration__lte schema: type: string - name: metadata__forms_completed_count required: false in: query description: metadata__forms_completed_count schema: type: string - name: metadata__forms_completed_count__gt required: false in: query description: metadata__forms_completed_count__gt schema: type: string - name: metadata__forms_completed_count__gte required: false in: query description: metadata__forms_completed_count__gte schema: type: string - name: metadata__forms_completed_count__lt required: false in: query description: metadata__forms_completed_count__lt schema: type: string - name: metadata__forms_completed_count__lte required: false in: query description: metadata__forms_completed_count__lte schema: type: string - name: metadata__forms_count required: false in: query description: metadata__forms_count schema: type: string - name: metadata__forms_count__gt required: false in: query description: metadata__forms_count__gt schema: type: string - name: metadata__forms_count__gte required: false in: query description: metadata__forms_count__gte schema: type: string - name: metadata__forms_count__lt required: false in: query description: metadata__forms_count__lt schema: type: string - name: metadata__forms_count__lte required: false in: query description: metadata__forms_count__lte schema: type: string - name: metadata__last_accepted_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_accepted_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_accepted_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_active_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_active_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_assigned_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_assigned_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_cancelled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_cancelled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_transit_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_transit_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_unassigned_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_unassigned_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__signatures_count required: false in: query description: metadata__signatures_count schema: type: string - name: metadata__signatures_count__gt required: false in: query description: metadata__signatures_count__gt schema: type: string - name: metadata__signatures_count__gte required: false in: query description: metadata__signatures_count__gte schema: type: string - name: metadata__signatures_count__lt required: false in: query description: metadata__signatures_count__lt schema: type: string - name: metadata__signatures_count__lte required: false in: query description: metadata__signatures_count__lte schema: type: string - name: metadata__task_event_notes_count required: false in: query description: metadata__task_event_notes_count schema: type: string - name: metadata__task_event_notes_count__gt required: false in: query description: metadata__task_event_notes_count__gt schema: type: string - name: metadata__task_event_notes_count__gte required: false in: query description: metadata__task_event_notes_count__gte schema: type: string - name: metadata__task_event_notes_count__lt required: false in: query description: metadata__task_event_notes_count__lt schema: type: string - name: metadata__task_event_notes_count__lte required: false in: query description: metadata__task_event_notes_count__lte schema: type: string - name: metadata__transit_distance required: false in: query description: metadata__transit_distance schema: type: string - name: metadata__transit_distance__gt required: false in: query description: metadata__transit_distance__gt schema: type: string - name: metadata__transit_distance__gte required: false in: query description: metadata__transit_distance__gte schema: type: string - name: metadata__transit_distance__lt required: false in: query description: metadata__transit_distance__lt schema: type: string - name: metadata__transit_distance__lte required: false in: query description: metadata__transit_distance__lte schema: type: string - name: metadata__transit_duration required: false in: query description: metadata__transit_duration schema: type: string - name: metadata__transit_duration__gt required: false in: query description: metadata__transit_duration__gt schema: type: string - name: metadata__transit_duration__gte required: false in: query description: metadata__transit_duration__gte schema: type: string - name: metadata__transit_duration__lt required: false in: query description: metadata__transit_duration__lt schema: type: string - name: metadata__transit_duration__lte required: false in: query description: metadata__transit_duration__lte schema: type: string - name: metadata__unassigned_distance required: false in: query description: metadata__unassigned_distance schema: type: string - name: metadata__unassigned_distance__gt required: false in: query description: metadata__unassigned_distance__gt schema: type: string - name: metadata__unassigned_distance__gte required: false in: query description: metadata__unassigned_distance__gte schema: type: string - name: metadata__unassigned_distance__lt required: false in: query description: metadata__unassigned_distance__lt schema: type: string - name: metadata__unassigned_distance__lte required: false in: query description: metadata__unassigned_distance__lte schema: type: string - name: metadata__unassigned_duration required: false in: query description: metadata__unassigned_duration schema: type: string - name: metadata__unassigned_duration__gt required: false in: query description: metadata__unassigned_duration__gt schema: type: string - name: metadata__unassigned_duration__gte required: false in: query description: metadata__unassigned_duration__gte schema: type: string - name: metadata__unassigned_duration__lt required: false in: query description: metadata__unassigned_duration__lt schema: type: string - name: metadata__unassigned_duration__lte required: false in: query description: metadata__unassigned_duration__lte schema: type: string - 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 - name: order__auto_assign required: false in: query description: order__auto_assign schema: type: string - name: order__created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: order__created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: order__created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_by required: false in: query description: order__created_by schema: type: string - name: order__created_by__in required: false in: query description: order__created_by__in schema: type: string - name: order__created_by__isnull required: false in: query description: order__created_by__isnull schema: type: string - name: order__external_id required: false in: query description: order__external_id schema: type: string - name: order__external_id__icontains required: false in: query description: order__external_id__icontains schema: type: string - name: order__external_id__in required: false in: query description: order__external_id__in schema: type: string - name: order__external_id__iregex required: false in: query description: order__external_id__iregex schema: type: string - name: order__external_id__isnull required: false in: query description: order__external_id__isnull schema: type: string - name: order__external_id__istartswith required: false in: query description: order__external_id__istartswith schema: type: string - name: order__external_id__search required: false in: query description: 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 - name: order__reference required: false in: query description: order__reference schema: type: string - name: order__reference__icontains required: false in: query description: order__reference__icontains schema: type: string - name: order__reference__in required: false in: query description: order__reference__in schema: type: string - name: order__reference__iregex required: false in: query description: order__reference__iregex schema: type: string - name: order__reference__istartswith required: false in: query description: order__reference__istartswith schema: type: string - name: order__reference__search required: false in: query description: order__reference__search schema: type: string - name: order_id required: false in: query description: order_id schema: type: string - name: order_id__in required: false in: query description: order_id__in schema: type: string - name: order_id__isnull required: false in: query description: order_id__isnull schema: type: string - name: orderer required: false in: query schema: type: string format: uuid - name: orderer__id required: false in: query description: orderer__id schema: type: string - name: orderer__id__in required: false in: query description: orderer__id__in schema: type: string - name: orderer__id__isnull required: false in: query description: orderer__id__isnull schema: type: string - name: orderer__in required: false in: query description: comma separated value schema: type: string - name: orderer__name required: false in: query description: orderer__name schema: type: string - name: orderer__name__icontains required: false in: query description: orderer__name__icontains schema: type: string - name: orderer_id required: false in: query description: orderer_id schema: type: string - name: orderer_id__in required: false in: query description: orderer_id__in schema: type: string - name: orderer_id__isnull required: false in: query description: orderer_id__isnull schema: type: string - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: owner_id required: false in: query description: owner_id schema: type: string - name: owner_id__in required: false in: query description: owner_id__in schema: type: string - name: owner_id__isnull required: false in: query description: owner_id__isnull schema: type: string - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: position__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: d496b7fd-b2c9-40a8-835e-6a74c8350cf3,13bf175a-47c5-4e3b-9766-4a0fe715a83b - 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: d496b7fd-b2c9-40a8-835e-6a74c8350cf3,13bf175a-47c5-4e3b-9766-4a0fe715a83b - 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: d496b7fd-b2c9-40a8-835e-6a74c8350cf3,13bf175a-47c5-4e3b-9766-4a0fe715a83b - name: priority required: false in: query description: priority schema: type: string - name: priority__gt required: false in: query description: priority__gt schema: type: string - name: priority__gte required: false in: query description: priority__gte schema: type: string - name: priority__in required: false in: query description: priority__in schema: type: string - name: priority__lt required: false in: query description: priority__lt schema: type: string - name: priority__lte required: false in: query description: priority__lte schema: type: string - 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 - name: receiver_id required: false in: query description: receiver_id schema: type: string - name: receiver_id__in required: false in: query description: receiver_id__in schema: type: string - name: receiver_id__isnull required: false in: query description: receiver_id__isnull schema: type: string - name: reference required: false in: query description: reference schema: type: string - name: reference__icontains required: false in: query description: reference__icontains schema: type: string - name: reference__in required: false in: query description: reference__in schema: type: string - name: reference__iregex required: false in: query description: reference__iregex schema: type: string - name: reference__istartswith required: false in: query description: reference__istartswith schema: type: string - name: reference__search required: false in: query description: reference__search schema: type: string - name: route required: false in: query schema: type: string format: uuid - name: route__in required: false in: query description: comma separated value schema: type: string - name: route_id required: false in: query description: route_id schema: type: string - name: route_id__in required: false in: query description: route_id__in schema: type: string - name: route_id__isnull required: false in: query description: route_id__isnull schema: type: string - name: scheduled_time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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 - name: state required: false in: query description: state schema: type: string enum: - unassigned - assigned - accepted - transit - active - completed - failed - 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 - name: unassignee_id required: false in: query description: unassignee_id schema: type: string - name: unassignee_id__in required: false in: query description: unassignee_id__in schema: type: string - name: unassignee_id__isnull required: false in: query description: unassignee_id__isnull schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: - scenes security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedDashboardSceneList' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedDashboardSceneList' description: '' /scenes/order_list/: get: operationId: scenes_order_list_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: external_id required: false in: query description: external_id schema: type: string - name: id required: false in: query description: id 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: reference required: false in: query description: reference schema: type: string - name: search required: false in: query description: A search term. schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - scenes security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedOrderListSceneList' description: '' /scenes/recurrence_list/: get: operationId: scenes_recurrence_list_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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: integer - name: is_active required: false in: query description: is_active schema: type: string - name: last_errored_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_errored_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_errored_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_errored_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_recurred_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_recurred_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_recurred_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_scheduled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: last_scheduled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: last_scheduled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: next_scheduled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: next_scheduled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: next_scheduled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order required: false in: query description: Filter by order and previous orders example: 626b6833-1f73-4270-98d6-34cd7d2fc7d1 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 - name: search required: false in: query description: A search term. schema: type: string - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - scenes security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedRecurrenceListSceneList' description: '' /scenes/task_list/: get: operationId: scenes_task_list_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: address__apartment_number required: false in: query description: address__apartment_number schema: type: string - name: address__apartment_number__icontains required: false in: query description: address__apartment_number__icontains schema: type: string - name: address__apartment_number__in required: false in: query description: address__apartment_number__in schema: type: string - name: address__apartment_number__iregex required: false in: query description: address__apartment_number__iregex schema: type: string - name: address__apartment_number__istartswith required: false in: query description: address__apartment_number__istartswith schema: type: string - name: address__apartment_number__search required: false in: query description: address__apartment_number__search schema: type: string - name: address__city required: false in: query description: address__city schema: type: string - name: address__city__icontains required: false in: query description: address__city__icontains schema: type: string - name: address__city__in required: false in: query description: address__city__in schema: type: string - name: address__city__iregex required: false in: query description: address__city__iregex schema: type: string - name: address__city__istartswith required: false in: query description: address__city__istartswith schema: type: string - name: address__city__search required: false in: query description: address__city__search schema: type: string - name: address__country required: false in: query description: address__country schema: type: string - name: address__country__icontains required: false in: query description: address__country__icontains schema: type: string - name: address__country__in required: false in: query description: address__country__in schema: type: string - name: address__country__iregex required: false in: query description: address__country__iregex schema: type: string - name: address__country__istartswith required: false in: query description: address__country__istartswith schema: type: string - name: address__country__search required: false in: query description: address__country__search schema: type: string - name: address__country_code required: false in: query description: address__country_code schema: type: string - name: address__country_code__icontains required: false in: query description: address__country_code__icontains schema: type: string - name: address__country_code__in required: false in: query description: address__country_code__in schema: type: string - name: address__country_code__iregex required: false in: query description: address__country_code__iregex schema: type: string - name: address__country_code__istartswith required: false in: query description: address__country_code__istartswith schema: type: string - name: address__country_code__search required: false in: query description: address__country_code__search schema: type: string - name: address__formatted_address required: false in: query description: address__formatted_address schema: type: string - name: address__formatted_address__icontains required: false in: query description: address__formatted_address__icontains schema: type: string - name: address__formatted_address__in required: false in: query description: address__formatted_address__in schema: type: string - name: address__formatted_address__iregex required: false in: query description: address__formatted_address__iregex schema: type: string - name: address__formatted_address__istartswith required: false in: query description: address__formatted_address__istartswith schema: type: string - name: address__formatted_address__search required: false in: query description: address__formatted_address__search schema: type: string - name: address__geocode_failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocode_failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocode_failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocoded_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocoded_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__google_place_id required: false in: query description: address__google_place_id schema: type: string - name: address__google_place_id__icontains required: false in: query description: address__google_place_id__icontains schema: type: string - name: address__google_place_id__in required: false in: query description: address__google_place_id__in schema: type: string - name: address__google_place_id__iregex required: false in: query description: address__google_place_id__iregex schema: type: string - name: address__google_place_id__istartswith required: false in: query description: address__google_place_id__istartswith schema: type: string - name: address__google_place_id__search required: false in: query description: address__google_place_id__search schema: type: string - name: address__house_number required: false in: query description: address__house_number schema: type: string - name: address__house_number__icontains required: false in: query description: address__house_number__icontains schema: type: string - name: address__house_number__in required: false in: query description: address__house_number__in schema: type: string - name: address__house_number__iregex required: false in: query description: address__house_number__iregex schema: type: string - name: address__house_number__istartswith required: false in: query description: address__house_number__istartswith schema: type: string - name: address__house_number__search required: false in: query description: address__house_number__search schema: type: string - name: address__point_of_interest required: false in: query description: address__point_of_interest schema: type: string - name: address__point_of_interest__icontains required: false in: query description: address__point_of_interest__icontains schema: type: string - name: address__point_of_interest__in required: false in: query description: address__point_of_interest__in schema: type: string - name: address__point_of_interest__iregex required: false in: query description: address__point_of_interest__iregex schema: type: string - name: address__point_of_interest__istartswith required: false in: query description: address__point_of_interest__istartswith schema: type: string - name: address__point_of_interest__search required: false in: query description: address__point_of_interest__search schema: type: string - name: address__postal_code required: false in: query description: address__postal_code schema: type: string - name: address__postal_code__icontains required: false in: query description: address__postal_code__icontains schema: type: string - name: address__postal_code__in required: false in: query description: address__postal_code__in schema: type: string - name: address__postal_code__iregex required: false in: query description: address__postal_code__iregex schema: type: string - name: address__postal_code__istartswith required: false in: query description: address__postal_code__istartswith schema: type: string - name: address__postal_code__search required: false in: query description: address__postal_code__search schema: type: string - name: address__raw_address required: false in: query description: address__raw_address schema: type: string - name: address__raw_address__icontains required: false in: query description: address__raw_address__icontains schema: type: string - name: address__raw_address__in required: false in: query description: address__raw_address__in schema: type: string - name: address__raw_address__iregex required: false in: query description: address__raw_address__iregex schema: type: string - name: address__raw_address__istartswith required: false in: query description: address__raw_address__istartswith schema: type: string - name: address__raw_address__search required: false in: query description: address__raw_address__search schema: type: string - name: address__state required: false in: query description: address__state schema: type: string - name: address__state__icontains required: false in: query description: address__state__icontains schema: type: string - name: address__state__in required: false in: query description: address__state__in schema: type: string - name: address__state__iregex required: false in: query description: address__state__iregex schema: type: string - name: address__state__istartswith required: false in: query description: address__state__istartswith schema: type: string - name: address__state__search required: false in: query description: address__state__search schema: type: string - name: address__street required: false in: query description: address__street schema: type: string - name: address__street__icontains required: false in: query description: address__street__icontains schema: type: string - name: address__street__in required: false in: query description: address__street__in schema: type: string - name: address__street__iregex required: false in: query description: address__street__iregex schema: type: string - name: address__street__istartswith required: false in: query description: address__street__istartswith schema: type: string - name: address__street__search required: false in: query description: 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 - name: address_id required: false in: query description: address_id schema: type: string - name: address_id__in required: false in: query description: address_id__in schema: type: string - name: address_id__isnull required: false in: query description: address_id__isnull schema: type: string - name: assignee required: false in: query schema: type: string format: uuid - name: assignee__email required: false in: query description: assignee__email schema: type: string - name: assignee__email__icontains required: false in: query description: assignee__email__icontains schema: type: string - name: assignee__email__iregex required: false in: query description: assignee__email__iregex schema: type: string - name: assignee__email__isnull required: false in: query description: assignee__email__isnull schema: type: string - name: assignee__email__istartswith required: false in: query description: assignee__email__istartswith schema: type: string - name: assignee__email__search required: false in: query description: assignee__email__search schema: type: string - name: assignee__first_name required: false in: query description: assignee__first_name schema: type: string - name: assignee__first_name__icontains required: false in: query description: assignee__first_name__icontains schema: type: string - name: assignee__first_name__iregex required: false in: query description: assignee__first_name__iregex schema: type: string - name: assignee__first_name__isnull required: false in: query description: assignee__first_name__isnull schema: type: string - name: assignee__first_name__istartswith required: false in: query description: assignee__first_name__istartswith schema: type: string - name: assignee__first_name__search required: false in: query description: assignee__first_name__search schema: type: string - name: assignee__in required: false in: query description: comma separated value schema: type: string - name: assignee__last_name required: false in: query description: assignee__last_name schema: type: string - name: assignee__last_name__icontains required: false in: query description: assignee__last_name__icontains schema: type: string - name: assignee__last_name__iregex required: false in: query description: assignee__last_name__iregex schema: type: string - name: assignee__last_name__isnull required: false in: query description: assignee__last_name__isnull schema: type: string - name: assignee__last_name__istartswith required: false in: query description: assignee__last_name__istartswith schema: type: string - name: assignee__last_name__search required: false in: query description: assignee__last_name__search schema: type: string - name: assignee__phone required: false in: query description: assignee__phone schema: type: string - name: assignee__phone__icontains required: false in: query description: assignee__phone__icontains schema: type: string - name: assignee__phone__iregex required: false in: query description: assignee__phone__iregex schema: type: string - name: assignee__phone__isnull required: false in: query description: assignee__phone__isnull schema: type: string - name: assignee__phone__istartswith required: false in: query description: assignee__phone__istartswith schema: type: string - name: assignee__phone__search required: false in: query description: assignee__phone__search schema: type: string - name: assignee_id required: false in: query description: assignee_id schema: type: string - name: assignee_id__in required: false in: query description: assignee_id__in schema: type: string - name: assignee_id__isnull required: false in: query description: assignee_id__isnull schema: type: string - name: assignee_proximity required: false in: query description: assignee_proximity schema: type: string enum: - away - near - name: assignee_proximity__in required: false in: query description: assignee_proximity__in schema: type: string - 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: cancelled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: cancelled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: cancelled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: category required: false in: query description: category schema: type: string enum: - assignment - pick_up - drop_off - warehouse - name: category__in required: false in: query description: category__in schema: type: string - name: complete_after__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: contact__company__icontains required: false in: query description: contact__company__icontains schema: type: string - name: contact__company__in required: false in: query description: contact__company__in schema: type: string - name: contact__company__iregex required: false in: query description: contact__company__iregex schema: type: string - name: contact__company__istartswith required: false in: query description: contact__company__istartswith schema: type: string - name: contact__company__search required: false in: query description: contact__company__search schema: type: string - name: contact__email required: false in: query description: contact__email schema: type: string - name: contact__email__icontains required: false in: query description: contact__email__icontains schema: type: string - name: contact__email__in required: false in: query description: contact__email__in schema: type: string - name: contact__email__iregex required: false in: query description: contact__email__iregex schema: type: string - name: contact__email__istartswith required: false in: query description: contact__email__istartswith schema: type: string - name: contact__email__search required: false in: query description: 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 - name: contact__name required: false in: query description: contact__name schema: type: string - name: contact__name__icontains required: false in: query description: contact__name__icontains schema: type: string - name: contact__name__in required: false in: query description: contact__name__in schema: type: string - name: contact__name__iregex required: false in: query description: contact__name__iregex schema: type: string - name: contact__name__istartswith required: false in: query description: contact__name__istartswith schema: type: string - name: contact__name__search required: false in: query description: contact__name__search schema: type: string - name: contact__notes required: false in: query description: contact__notes schema: type: string - name: contact__notes__icontains required: false in: query description: contact__notes__icontains schema: type: string - name: contact__notes__in required: false in: query description: contact__notes__in schema: type: string - name: contact__notes__iregex required: false in: query description: contact__notes__iregex schema: type: string - name: contact__notes__istartswith required: false in: query description: contact__notes__istartswith schema: type: string - name: contact__notes__search required: false in: query description: contact__notes__search schema: type: string - name: contact__phone required: false in: query description: contact__phone schema: type: string - name: contact__phone__icontains required: false in: query description: contact__phone__icontains schema: type: string - name: contact__phone__in required: false in: query description: contact__phone__in schema: type: string - name: contact__phone__iregex required: false in: query description: contact__phone__iregex schema: type: string - name: contact__phone__istartswith required: false in: query description: contact__phone__istartswith schema: type: string - name: contact__phone__search required: false in: query description: 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_data required: false in: query description: Django ORM lookups can be used. Metafield `is_searchable` must be True. schema: type: string - name: contact_id required: false in: query description: contact_id schema: type: string - name: contact_id__in required: false in: query description: contact_id__in schema: type: string - name: contact_id__isnull required: false in: query description: contact_id__isnull schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_by required: false in: query description: created_by schema: type: string - name: created_by__in required: false in: query description: created_by__in schema: type: string - name: created_by__isnull required: false in: query description: created_by__isnull schema: type: string - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: description required: false in: query description: description schema: type: string - name: description__icontains required: false in: query description: description__icontains schema: type: string - name: description__iregex required: false in: query description: description__iregex schema: type: string - name: description__istartswith required: false in: query description: description__istartswith schema: type: string - name: description__search required: false in: query description: description__search schema: type: string - name: duration required: false in: query description: duration schema: type: string - name: duration__gt required: false in: query description: duration__gt schema: type: string - name: duration__gte required: false in: query description: duration__gte schema: type: string - name: duration__lt required: false in: query description: duration__lt schema: type: string - name: duration__lte required: false in: query description: duration__lte schema: type: string - name: external_id required: false in: query description: external_id schema: type: string - name: external_id__icontains required: false in: query description: external_id__icontains schema: type: string - name: external_id__in required: false in: query description: external_id__in schema: type: string - name: external_id__iregex required: false in: query description: external_id__iregex schema: type: string - name: external_id__isnull required: false in: query description: external_id__isnull schema: type: string - name: external_id__istartswith required: false in: query description: external_id__istartswith schema: type: string - name: external_id__search required: false in: query description: external_id__search schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: id required: false in: query description: id schema: type: string - name: id__in required: false in: query description: id__in schema: type: string - name: is_optimal required: false in: query description: is_optimal schema: type: string - name: is_optimal__isnull required: false in: query description: is_optimal__isnull schema: type: string - name: metadata__accepted_distance required: false in: query description: metadata__accepted_distance schema: type: string - name: metadata__accepted_distance__gt required: false in: query description: metadata__accepted_distance__gt schema: type: string - name: metadata__accepted_distance__gte required: false in: query description: metadata__accepted_distance__gte schema: type: string - name: metadata__accepted_distance__lt required: false in: query description: metadata__accepted_distance__lt schema: type: string - name: metadata__accepted_distance__lte required: false in: query description: metadata__accepted_distance__lte schema: type: string - name: metadata__accepted_duration required: false in: query description: metadata__accepted_duration schema: type: string - name: metadata__accepted_duration__gt required: false in: query description: metadata__accepted_duration__gt schema: type: string - name: metadata__accepted_duration__gte required: false in: query description: metadata__accepted_duration__gte schema: type: string - name: metadata__accepted_duration__lt required: false in: query description: metadata__accepted_duration__lt schema: type: string - name: metadata__accepted_duration__lte required: false in: query description: metadata__accepted_duration__lte schema: type: string - name: metadata__active_distance required: false in: query description: metadata__active_distance schema: type: string - name: metadata__active_distance__gt required: false in: query description: metadata__active_distance__gt schema: type: string - name: metadata__active_distance__gte required: false in: query description: metadata__active_distance__gte schema: type: string - name: metadata__active_distance__lt required: false in: query description: metadata__active_distance__lt schema: type: string - name: metadata__active_distance__lte required: false in: query description: metadata__active_distance__lte schema: type: string - name: metadata__active_duration required: false in: query description: metadata__active_duration schema: type: string - name: metadata__active_duration__gt required: false in: query description: metadata__active_duration__gt schema: type: string - name: metadata__active_duration__gte required: false in: query description: metadata__active_duration__gte schema: type: string - name: metadata__active_duration__lt required: false in: query description: metadata__active_duration__lt schema: type: string - name: metadata__active_duration__lte required: false in: query description: metadata__active_duration__lte schema: type: string - name: metadata__assigned_distance required: false in: query description: metadata__assigned_distance schema: type: string - name: metadata__assigned_distance__gt required: false in: query description: metadata__assigned_distance__gt schema: type: string - name: metadata__assigned_distance__gte required: false in: query description: metadata__assigned_distance__gte schema: type: string - name: metadata__assigned_distance__lt required: false in: query description: metadata__assigned_distance__lt schema: type: string - name: metadata__assigned_distance__lte required: false in: query description: metadata__assigned_distance__lte schema: type: string - name: metadata__assigned_duration required: false in: query description: metadata__assigned_duration schema: type: string - name: metadata__assigned_duration__gt required: false in: query description: metadata__assigned_duration__gt schema: type: string - name: metadata__assigned_duration__gte required: false in: query description: metadata__assigned_duration__gte schema: type: string - name: metadata__assigned_duration__lt required: false in: query description: metadata__assigned_duration__lt schema: type: string - name: metadata__assigned_duration__lte required: false in: query description: metadata__assigned_duration__lte schema: type: string - name: metadata__cancelled_distance required: false in: query description: metadata__cancelled_distance schema: type: string - name: metadata__cancelled_distance__gt required: false in: query description: metadata__cancelled_distance__gt schema: type: string - name: metadata__cancelled_distance__gte required: false in: query description: metadata__cancelled_distance__gte schema: type: string - name: metadata__cancelled_distance__lt required: false in: query description: metadata__cancelled_distance__lt schema: type: string - name: metadata__cancelled_distance__lte required: false in: query description: metadata__cancelled_distance__lte schema: type: string - name: metadata__cancelled_duration required: false in: query description: metadata__cancelled_duration schema: type: string - name: metadata__cancelled_duration__gt required: false in: query description: metadata__cancelled_duration__gt schema: type: string - name: metadata__cancelled_duration__gte required: false in: query description: metadata__cancelled_duration__gte schema: type: string - name: metadata__cancelled_duration__lt required: false in: query description: metadata__cancelled_duration__lt schema: type: string - name: metadata__cancelled_duration__lte required: false in: query description: metadata__cancelled_duration__lte schema: type: string - name: metadata__completed_distance required: false in: query description: metadata__completed_distance schema: type: string - name: metadata__completed_distance__gt required: false in: query description: metadata__completed_distance__gt schema: type: string - name: metadata__completed_distance__gte required: false in: query description: metadata__completed_distance__gte schema: type: string - name: metadata__completed_distance__lt required: false in: query description: metadata__completed_distance__lt schema: type: string - name: metadata__completed_distance__lte required: false in: query description: metadata__completed_distance__lte schema: type: string - name: metadata__completed_duration required: false in: query description: metadata__completed_duration schema: type: string - name: metadata__completed_duration__gt required: false in: query description: metadata__completed_duration__gt schema: type: string - name: metadata__completed_duration__gte required: false in: query description: metadata__completed_duration__gte schema: type: string - name: metadata__completed_duration__lt required: false in: query description: metadata__completed_duration__lt schema: type: string - name: metadata__completed_duration__lte required: false in: query description: metadata__completed_duration__lte schema: type: string - name: metadata__documents_count required: false in: query description: metadata__documents_count schema: type: string - name: metadata__documents_count__gt required: false in: query description: metadata__documents_count__gt schema: type: string - name: metadata__documents_count__gte required: false in: query description: metadata__documents_count__gte schema: type: string - name: metadata__documents_count__lt required: false in: query description: metadata__documents_count__lt schema: type: string - name: metadata__documents_count__lte required: false in: query description: metadata__documents_count__lte schema: type: string - name: metadata__events_count required: false in: query description: metadata__events_count schema: type: string - name: metadata__events_count__gt required: false in: query description: metadata__events_count__gt schema: type: string - name: metadata__events_count__gte required: false in: query description: metadata__events_count__gte schema: type: string - name: metadata__events_count__lt required: false in: query description: metadata__events_count__lt schema: type: string - name: metadata__events_count__lte required: false in: query description: metadata__events_count__lte schema: type: string - name: metadata__failed_distance required: false in: query description: metadata__failed_distance schema: type: string - name: metadata__failed_distance__gt required: false in: query description: metadata__failed_distance__gt schema: type: string - name: metadata__failed_distance__gte required: false in: query description: metadata__failed_distance__gte schema: type: string - name: metadata__failed_distance__lt required: false in: query description: metadata__failed_distance__lt schema: type: string - name: metadata__failed_distance__lte required: false in: query description: metadata__failed_distance__lte schema: type: string - name: metadata__failed_duration required: false in: query description: metadata__failed_duration schema: type: string - name: metadata__failed_duration__gt required: false in: query description: metadata__failed_duration__gt schema: type: string - name: metadata__failed_duration__gte required: false in: query description: metadata__failed_duration__gte schema: type: string - name: metadata__failed_duration__lt required: false in: query description: metadata__failed_duration__lt schema: type: string - name: metadata__failed_duration__lte required: false in: query description: metadata__failed_duration__lte schema: type: string - name: metadata__forms_completed_count required: false in: query description: metadata__forms_completed_count schema: type: string - name: metadata__forms_completed_count__gt required: false in: query description: metadata__forms_completed_count__gt schema: type: string - name: metadata__forms_completed_count__gte required: false in: query description: metadata__forms_completed_count__gte schema: type: string - name: metadata__forms_completed_count__lt required: false in: query description: metadata__forms_completed_count__lt schema: type: string - name: metadata__forms_completed_count__lte required: false in: query description: metadata__forms_completed_count__lte schema: type: string - name: metadata__forms_count required: false in: query description: metadata__forms_count schema: type: string - name: metadata__forms_count__gt required: false in: query description: metadata__forms_count__gt schema: type: string - name: metadata__forms_count__gte required: false in: query description: metadata__forms_count__gte schema: type: string - name: metadata__forms_count__lt required: false in: query description: metadata__forms_count__lt schema: type: string - name: metadata__forms_count__lte required: false in: query description: metadata__forms_count__lte schema: type: string - name: metadata__last_accepted_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_accepted_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_accepted_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_active_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_active_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_assigned_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_assigned_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_cancelled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_cancelled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_transit_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_transit_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_unassigned_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_unassigned_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__signatures_count required: false in: query description: metadata__signatures_count schema: type: string - name: metadata__signatures_count__gt required: false in: query description: metadata__signatures_count__gt schema: type: string - name: metadata__signatures_count__gte required: false in: query description: metadata__signatures_count__gte schema: type: string - name: metadata__signatures_count__lt required: false in: query description: metadata__signatures_count__lt schema: type: string - name: metadata__signatures_count__lte required: false in: query description: metadata__signatures_count__lte schema: type: string - name: metadata__task_event_notes_count required: false in: query description: metadata__task_event_notes_count schema: type: string - name: metadata__task_event_notes_count__gt required: false in: query description: metadata__task_event_notes_count__gt schema: type: string - name: metadata__task_event_notes_count__gte required: false in: query description: metadata__task_event_notes_count__gte schema: type: string - name: metadata__task_event_notes_count__lt required: false in: query description: metadata__task_event_notes_count__lt schema: type: string - name: metadata__task_event_notes_count__lte required: false in: query description: metadata__task_event_notes_count__lte schema: type: string - name: metadata__transit_distance required: false in: query description: metadata__transit_distance schema: type: string - name: metadata__transit_distance__gt required: false in: query description: metadata__transit_distance__gt schema: type: string - name: metadata__transit_distance__gte required: false in: query description: metadata__transit_distance__gte schema: type: string - name: metadata__transit_distance__lt required: false in: query description: metadata__transit_distance__lt schema: type: string - name: metadata__transit_distance__lte required: false in: query description: metadata__transit_distance__lte schema: type: string - name: metadata__transit_duration required: false in: query description: metadata__transit_duration schema: type: string - name: metadata__transit_duration__gt required: false in: query description: metadata__transit_duration__gt schema: type: string - name: metadata__transit_duration__gte required: false in: query description: metadata__transit_duration__gte schema: type: string - name: metadata__transit_duration__lt required: false in: query description: metadata__transit_duration__lt schema: type: string - name: metadata__transit_duration__lte required: false in: query description: metadata__transit_duration__lte schema: type: string - name: metadata__unassigned_distance required: false in: query description: metadata__unassigned_distance schema: type: string - name: metadata__unassigned_distance__gt required: false in: query description: metadata__unassigned_distance__gt schema: type: string - name: metadata__unassigned_distance__gte required: false in: query description: metadata__unassigned_distance__gte schema: type: string - name: metadata__unassigned_distance__lt required: false in: query description: metadata__unassigned_distance__lt schema: type: string - name: metadata__unassigned_distance__lte required: false in: query description: metadata__unassigned_distance__lte schema: type: string - name: metadata__unassigned_duration required: false in: query description: metadata__unassigned_duration schema: type: string - name: metadata__unassigned_duration__gt required: false in: query description: metadata__unassigned_duration__gt schema: type: string - name: metadata__unassigned_duration__gte required: false in: query description: metadata__unassigned_duration__gte schema: type: string - name: metadata__unassigned_duration__lt required: false in: query description: metadata__unassigned_duration__lt schema: type: string - name: metadata__unassigned_duration__lte required: false in: query description: metadata__unassigned_duration__lte schema: type: string - 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 - name: order__auto_assign required: false in: query description: order__auto_assign schema: type: string - name: order__created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: order__created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: order__created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_by required: false in: query description: order__created_by schema: type: string - name: order__created_by__in required: false in: query description: order__created_by__in schema: type: string - name: order__created_by__isnull required: false in: query description: order__created_by__isnull schema: type: string - name: order__external_id required: false in: query description: order__external_id schema: type: string - name: order__external_id__icontains required: false in: query description: order__external_id__icontains schema: type: string - name: order__external_id__in required: false in: query description: order__external_id__in schema: type: string - name: order__external_id__iregex required: false in: query description: order__external_id__iregex schema: type: string - name: order__external_id__isnull required: false in: query description: order__external_id__isnull schema: type: string - name: order__external_id__istartswith required: false in: query description: order__external_id__istartswith schema: type: string - name: order__external_id__search required: false in: query description: 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 - name: order__reference required: false in: query description: order__reference schema: type: string - name: order__reference__icontains required: false in: query description: order__reference__icontains schema: type: string - name: order__reference__in required: false in: query description: order__reference__in schema: type: string - name: order__reference__iregex required: false in: query description: order__reference__iregex schema: type: string - name: order__reference__istartswith required: false in: query description: order__reference__istartswith schema: type: string - name: order__reference__search required: false in: query description: order__reference__search schema: type: string - name: order_id required: false in: query description: order_id schema: type: string - name: order_id__in required: false in: query description: order_id__in schema: type: string - name: order_id__isnull required: false in: query description: order_id__isnull schema: type: string - name: orderer required: false in: query schema: type: string format: uuid - name: orderer__id required: false in: query description: orderer__id schema: type: string - name: orderer__id__in required: false in: query description: orderer__id__in schema: type: string - name: orderer__id__isnull required: false in: query description: orderer__id__isnull schema: type: string - name: orderer__in required: false in: query description: comma separated value schema: type: string - name: orderer__name required: false in: query description: orderer__name schema: type: string - name: orderer__name__icontains required: false in: query description: orderer__name__icontains schema: type: string - name: orderer_id required: false in: query description: orderer_id schema: type: string - name: orderer_id__in required: false in: query description: orderer_id__in schema: type: string - name: orderer_id__isnull required: false in: query description: orderer_id__isnull schema: type: string - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: owner_id required: false in: query description: owner_id schema: type: string - name: owner_id__in required: false in: query description: owner_id__in schema: type: string - name: owner_id__isnull required: false in: query description: owner_id__isnull schema: type: string - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: position__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: 16c40a37-295b-4ca5-a6c0-7edb04bbf60e,a2bfdc09-39f3-40d1-8f09-8144b4692bab - 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: 16c40a37-295b-4ca5-a6c0-7edb04bbf60e,a2bfdc09-39f3-40d1-8f09-8144b4692bab - 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: 16c40a37-295b-4ca5-a6c0-7edb04bbf60e,a2bfdc09-39f3-40d1-8f09-8144b4692bab - name: priority required: false in: query description: priority schema: type: string - name: priority__gt required: false in: query description: priority__gt schema: type: string - name: priority__gte required: false in: query description: priority__gte schema: type: string - name: priority__in required: false in: query description: priority__in schema: type: string - name: priority__lt required: false in: query description: priority__lt schema: type: string - name: priority__lte required: false in: query description: priority__lte schema: type: string - 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 - name: receiver_id required: false in: query description: receiver_id schema: type: string - name: receiver_id__in required: false in: query description: receiver_id__in schema: type: string - name: receiver_id__isnull required: false in: query description: receiver_id__isnull schema: type: string - name: reference required: false in: query description: reference schema: type: string - name: reference__icontains required: false in: query description: reference__icontains schema: type: string - name: reference__in required: false in: query description: reference__in schema: type: string - name: reference__iregex required: false in: query description: reference__iregex schema: type: string - name: reference__istartswith required: false in: query description: reference__istartswith schema: type: string - name: reference__search required: false in: query description: reference__search schema: type: string - name: route required: false in: query schema: type: string format: uuid - name: route__in required: false in: query description: comma separated value schema: type: string - name: route_id required: false in: query description: route_id schema: type: string - name: route_id__in required: false in: query description: route_id__in schema: type: string - name: route_id__isnull required: false in: query description: route_id__isnull schema: type: string - name: scheduled_time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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 - name: state required: false in: query description: state schema: type: string enum: - unassigned - assigned - accepted - transit - active - completed - failed - 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 - name: unassignee_id required: false in: query description: unassignee_id schema: type: string - name: unassignee_id__in required: false in: query description: unassignee_id__in schema: type: string - name: unassignee_id__isnull required: false in: query description: unassignee_id__isnull schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: - scenes security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskListSceneList' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskListSceneList' description: '' /signatures/: get: operationId: signatures_list parameters: - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: integer - name: filename required: false in: query description: 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: format schema: type: string enum: - json - xlsx - name: mimetype required: false in: query description: 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 - name: source required: false in: query description: source schema: type: string enum: - web - mobile - integration - name: task required: false in: query description: task schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - signatures security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedSignatureList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedSignatureList' description: '' post: operationId: signatures_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - signatures requestBody: content: application/json: schema: $ref: '#/components/schemas/Signature' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Signature' multipart/form-data: schema: $ref: '#/components/schemas/Signature' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Signature' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Signature' description: '' /signatures/{id}/: get: operationId: signatures_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Signature' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Signature' description: '' delete: operationId: signatures_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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 parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - signatures requestBody: content: application/json: schema: $ref: '#/components/schemas/SignatureDeleteAction' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SignatureDeleteAction' multipart/form-data: schema: $ref: '#/components/schemas/SignatureDeleteAction' required: true security: - tokenAuth: [] responses: '204': description: No response body /sms/: get: operationId: sms_list parameters: - name: account required: false in: query description: account schema: type: string - name: alphanumeric_sender_id required: false in: query description: alphanumeric_sender_id schema: type: string - name: alphanumeric_sender_id__icontains required: false in: query description: alphanumeric_sender_id__icontains schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - in: query name: format schema: type: string enum: - json - xlsx - name: id required: false in: query description: id schema: type: string - name: message required: false in: query description: message schema: type: string - name: message__icontains required: false in: query description: 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: phone required: false in: query description: phone schema: type: string - name: phone__icontains required: false in: query description: phone__icontains schema: type: string - name: price required: false in: query description: price schema: type: string - name: price__gt required: false in: query description: price__gt schema: type: string - name: price__gte required: false in: query description: price__gte schema: type: string - name: price__lt required: false in: query description: price__lt schema: type: string - name: price__lte required: false in: query description: price__lte schema: type: string - name: provider required: false in: query description: provider schema: type: string enum: - twilio - smsapi - name: provider__in required: false in: query description: provider__in schema: type: string - name: received_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: received_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: received_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: received_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: search required: false in: query description: A search term. schema: type: string - name: segments_count required: false in: query description: segments_count schema: type: string - name: segments_count__gt required: false in: query description: segments_count__gt schema: type: string - name: segments_count__gte required: false in: query description: segments_count__gte schema: type: string - name: segments_count__lt required: false in: query description: segments_count__lt schema: type: string - name: segments_count__lte required: false in: query description: segments_count__lte schema: type: string - name: sent_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: sent_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: sent_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: sent_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: state required: false in: query description: state schema: type: string enum: - queued - over_quota - sent - failed - received - name: state__in required: false in: query description: state__in schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - sms security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedSMSList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedSMSList' description: '' post: operationId: sms_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - sms requestBody: content: application/json: schema: $ref: '#/components/schemas/SMS' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SMS' multipart/form-data: schema: $ref: '#/components/schemas/SMS' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/SMS' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/SMS' description: '' /sms/{id}/: get: operationId: sms_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/SMS' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/SMS' description: '' put: operationId: sms_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sms. required: true tags: - sms requestBody: content: application/json: schema: $ref: '#/components/schemas/SMS' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SMS' multipart/form-data: schema: $ref: '#/components/schemas/SMS' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/SMS' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/SMS' description: '' patch: operationId: sms_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sms. required: true tags: - sms requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedSMS' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedSMS' multipart/form-data: schema: $ref: '#/components/schemas/PatchedSMS' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/SMS' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/SMS' description: '' delete: operationId: sms_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sms. required: true tags: - sms security: - tokenAuth: [] responses: '204': description: No response body /sms/{id}/resend/: post: operationId: sms_resend_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this sms. required: true tags: - sms requestBody: content: application/json: schema: $ref: '#/components/schemas/SMS' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SMS' multipart/form-data: schema: $ref: '#/components/schemas/SMS' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/SMS' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/SMS' description: '' /task_address_features/: get: operationId: task_address_features_list parameters: - name: account required: false in: query description: account schema: type: string - name: assignee required: false in: query description: assignee schema: type: string - name: category required: false in: query description: category schema: type: string enum: - assignment - pick_up - drop_off - warehouse - name: complete_after__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: owner required: false in: query description: owner schema: type: string - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: position__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - task_address_features security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskAddressFeatureList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskAddressFeatureList' description: '' /task_address_features/{id}/: get: operationId: task_address_features_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/TaskAddressFeature' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TaskAddressFeature' description: '' /task_commands/: get: operationId: task_commands_list parameters: - name: accepted_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: accepted_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: accepted_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: accepted_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: accepted_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: accepted_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: accepted_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: accepted_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: accepted_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: accepted_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: action required: false in: query description: action schema: type: string enum: - update - reassign - assign - accept - unaccept - reject - unassign - transit - activate - complete - fail - cancel - assignee_near - assignee_away - name: assignee required: false in: query description: assignee schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: rejected_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: rejected_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: rejected_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: rejected_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: rejected_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: rejected_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: rejected_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: rejected_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: rejected_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: rejected_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: state required: false in: query description: state schema: type: string enum: - pending - accepted - rejected - name: task required: false in: query description: task schema: type: string - name: task__account required: false in: query description: task__account schema: type: string - name: time required: false in: query description: time schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: user required: false in: query description: user schema: type: string tags: - task_commands security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskCommandList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskCommandList' description: '' post: operationId: task_commands_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - task_commands requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskCommand' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TaskCommand' multipart/form-data: schema: $ref: '#/components/schemas/TaskCommand' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskCommand' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TaskCommand' description: '' /task_commands/{id}/: get: operationId: task_commands_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task command. required: true tags: - task_commands security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskCommand' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TaskCommand' description: '' put: operationId: task_commands_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task command. required: true tags: - task_commands requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskCommand' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TaskCommand' multipart/form-data: schema: $ref: '#/components/schemas/TaskCommand' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskCommand' application/xlsx; version=2.4.13: 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: event required: false in: query description: event schema: type: string enum: - create - assign - unassign - reject - accept - unaccept - transit - activate - complete - fail - cancel - assignee_near - assignee_away - updated - in: query name: format schema: type: string enum: - json - xlsx - name: from_state required: false in: query description: from_state schema: type: string enum: - unassigned - assigned - accepted - transit - active - completed - failed - cancelled - away - 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 - name: to_state required: false in: query description: to_state schema: type: string enum: - unassigned - assigned - accepted - transit - active - completed - failed - cancelled - away - near - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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.4.13: schema: $ref: '#/components/schemas/PaginatedTaskEventTrackList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskEventTrackList' description: '' /task_event_tracks/{id}/: get: operationId: task_event_tracks_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/TaskEventTrack' application/xlsx; version=2.4.13: 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: - name: assignee required: false in: query description: assignee schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: event required: false in: query description: event schema: type: string enum: - create - assign - unassign - reject - accept - unaccept - transit - activate - complete - fail - cancel - assignee_near - assignee_away - updated - name: event__in required: false in: query description: event__in schema: type: string - name: field required: false in: query description: field schema: type: string enum: - '' - state - assignee_proximity - in: query name: format schema: type: string enum: - json - xlsx - name: from_state required: false in: query description: from_state schema: type: string enum: - unassigned - assigned - accepted - transit - active - completed - failed - cancelled - away - near - name: from_state__in required: false in: query description: from_state__in 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: task required: false in: query description: task schema: type: string - name: task__account required: false in: query description: task__account schema: type: string - name: to_state required: false in: query description: to_state schema: type: string enum: - unassigned - assigned - accepted - transit - active - completed - failed - cancelled - away - near - name: to_state__in required: false in: query description: to_state__in schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: user required: false in: query description: user schema: type: string tags: - task_events security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskEventSerializerV2List' application/xlsx; version=2.4.13: 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: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/TaskEventSerializerV2' application/xlsx; version=2.4.13: 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 - name: address__apartment_number required: false in: query description: address__apartment_number schema: type: string - name: address__apartment_number__icontains required: false in: query description: address__apartment_number__icontains schema: type: string - name: address__apartment_number__in required: false in: query description: address__apartment_number__in schema: type: string - name: address__apartment_number__iregex required: false in: query description: address__apartment_number__iregex schema: type: string - name: address__apartment_number__istartswith required: false in: query description: address__apartment_number__istartswith schema: type: string - name: address__apartment_number__search required: false in: query description: address__apartment_number__search schema: type: string - name: address__city required: false in: query description: address__city schema: type: string - name: address__city__icontains required: false in: query description: address__city__icontains schema: type: string - name: address__city__in required: false in: query description: address__city__in schema: type: string - name: address__city__iregex required: false in: query description: address__city__iregex schema: type: string - name: address__city__istartswith required: false in: query description: address__city__istartswith schema: type: string - name: address__city__search required: false in: query description: address__city__search schema: type: string - name: address__country required: false in: query description: address__country schema: type: string - name: address__country__icontains required: false in: query description: address__country__icontains schema: type: string - name: address__country__in required: false in: query description: address__country__in schema: type: string - name: address__country__iregex required: false in: query description: address__country__iregex schema: type: string - name: address__country__istartswith required: false in: query description: address__country__istartswith schema: type: string - name: address__country__search required: false in: query description: address__country__search schema: type: string - name: address__country_code required: false in: query description: address__country_code schema: type: string - name: address__country_code__icontains required: false in: query description: address__country_code__icontains schema: type: string - name: address__country_code__in required: false in: query description: address__country_code__in schema: type: string - name: address__country_code__iregex required: false in: query description: address__country_code__iregex schema: type: string - name: address__country_code__istartswith required: false in: query description: address__country_code__istartswith schema: type: string - name: address__country_code__search required: false in: query description: address__country_code__search schema: type: string - name: address__formatted_address required: false in: query description: address__formatted_address schema: type: string - name: address__formatted_address__icontains required: false in: query description: address__formatted_address__icontains schema: type: string - name: address__formatted_address__in required: false in: query description: address__formatted_address__in schema: type: string - name: address__formatted_address__iregex required: false in: query description: address__formatted_address__iregex schema: type: string - name: address__formatted_address__istartswith required: false in: query description: address__formatted_address__istartswith schema: type: string - name: address__formatted_address__search required: false in: query description: address__formatted_address__search schema: type: string - name: address__geocode_failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocode_failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocode_failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocoded_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocoded_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__google_place_id required: false in: query description: address__google_place_id schema: type: string - name: address__google_place_id__icontains required: false in: query description: address__google_place_id__icontains schema: type: string - name: address__google_place_id__in required: false in: query description: address__google_place_id__in schema: type: string - name: address__google_place_id__iregex required: false in: query description: address__google_place_id__iregex schema: type: string - name: address__google_place_id__istartswith required: false in: query description: address__google_place_id__istartswith schema: type: string - name: address__google_place_id__search required: false in: query description: address__google_place_id__search schema: type: string - name: address__house_number required: false in: query description: address__house_number schema: type: string - name: address__house_number__icontains required: false in: query description: address__house_number__icontains schema: type: string - name: address__house_number__in required: false in: query description: address__house_number__in schema: type: string - name: address__house_number__iregex required: false in: query description: address__house_number__iregex schema: type: string - name: address__house_number__istartswith required: false in: query description: address__house_number__istartswith schema: type: string - name: address__house_number__search required: false in: query description: address__house_number__search schema: type: string - name: address__point_of_interest required: false in: query description: address__point_of_interest schema: type: string - name: address__point_of_interest__icontains required: false in: query description: address__point_of_interest__icontains schema: type: string - name: address__point_of_interest__in required: false in: query description: address__point_of_interest__in schema: type: string - name: address__point_of_interest__iregex required: false in: query description: address__point_of_interest__iregex schema: type: string - name: address__point_of_interest__istartswith required: false in: query description: address__point_of_interest__istartswith schema: type: string - name: address__point_of_interest__search required: false in: query description: address__point_of_interest__search schema: type: string - name: address__postal_code required: false in: query description: address__postal_code schema: type: string - name: address__postal_code__icontains required: false in: query description: address__postal_code__icontains schema: type: string - name: address__postal_code__in required: false in: query description: address__postal_code__in schema: type: string - name: address__postal_code__iregex required: false in: query description: address__postal_code__iregex schema: type: string - name: address__postal_code__istartswith required: false in: query description: address__postal_code__istartswith schema: type: string - name: address__postal_code__search required: false in: query description: address__postal_code__search schema: type: string - name: address__raw_address required: false in: query description: address__raw_address schema: type: string - name: address__raw_address__icontains required: false in: query description: address__raw_address__icontains schema: type: string - name: address__raw_address__in required: false in: query description: address__raw_address__in schema: type: string - name: address__raw_address__iregex required: false in: query description: address__raw_address__iregex schema: type: string - name: address__raw_address__istartswith required: false in: query description: address__raw_address__istartswith schema: type: string - name: address__raw_address__search required: false in: query description: address__raw_address__search schema: type: string - name: address__state required: false in: query description: address__state schema: type: string - name: address__state__icontains required: false in: query description: address__state__icontains schema: type: string - name: address__state__in required: false in: query description: address__state__in schema: type: string - name: address__state__iregex required: false in: query description: address__state__iregex schema: type: string - name: address__state__istartswith required: false in: query description: address__state__istartswith schema: type: string - name: address__state__search required: false in: query description: address__state__search schema: type: string - name: address__street required: false in: query description: address__street schema: type: string - name: address__street__icontains required: false in: query description: address__street__icontains schema: type: string - name: address__street__in required: false in: query description: address__street__in schema: type: string - name: address__street__iregex required: false in: query description: address__street__iregex schema: type: string - name: address__street__istartswith required: false in: query description: address__street__istartswith schema: type: string - name: address__street__search required: false in: query description: 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 - name: address_id required: false in: query description: address_id schema: type: string - name: address_id__in required: false in: query description: address_id__in schema: type: string - name: address_id__isnull required: false in: query description: address_id__isnull schema: type: string - name: assignee required: false in: query schema: type: string format: uuid - name: assignee__email required: false in: query description: assignee__email schema: type: string - name: assignee__email__icontains required: false in: query description: assignee__email__icontains schema: type: string - name: assignee__email__iregex required: false in: query description: assignee__email__iregex schema: type: string - name: assignee__email__isnull required: false in: query description: assignee__email__isnull schema: type: string - name: assignee__email__istartswith required: false in: query description: assignee__email__istartswith schema: type: string - name: assignee__email__search required: false in: query description: assignee__email__search schema: type: string - name: assignee__first_name required: false in: query description: assignee__first_name schema: type: string - name: assignee__first_name__icontains required: false in: query description: assignee__first_name__icontains schema: type: string - name: assignee__first_name__iregex required: false in: query description: assignee__first_name__iregex schema: type: string - name: assignee__first_name__isnull required: false in: query description: assignee__first_name__isnull schema: type: string - name: assignee__first_name__istartswith required: false in: query description: assignee__first_name__istartswith schema: type: string - name: assignee__first_name__search required: false in: query description: assignee__first_name__search schema: type: string - name: assignee__in required: false in: query description: comma separated value schema: type: string - name: assignee__last_name required: false in: query description: assignee__last_name schema: type: string - name: assignee__last_name__icontains required: false in: query description: assignee__last_name__icontains schema: type: string - name: assignee__last_name__iregex required: false in: query description: assignee__last_name__iregex schema: type: string - name: assignee__last_name__isnull required: false in: query description: assignee__last_name__isnull schema: type: string - name: assignee__last_name__istartswith required: false in: query description: assignee__last_name__istartswith schema: type: string - name: assignee__last_name__search required: false in: query description: assignee__last_name__search schema: type: string - name: assignee__phone required: false in: query description: assignee__phone schema: type: string - name: assignee__phone__icontains required: false in: query description: assignee__phone__icontains schema: type: string - name: assignee__phone__iregex required: false in: query description: assignee__phone__iregex schema: type: string - name: assignee__phone__isnull required: false in: query description: assignee__phone__isnull schema: type: string - name: assignee__phone__istartswith required: false in: query description: assignee__phone__istartswith schema: type: string - name: assignee__phone__search required: false in: query description: assignee__phone__search schema: type: string - name: assignee_id required: false in: query description: assignee_id schema: type: string - name: assignee_id__in required: false in: query description: assignee_id__in schema: type: string - name: assignee_id__isnull required: false in: query description: assignee_id__isnull schema: type: string - name: assignee_proximity required: false in: query description: assignee_proximity schema: type: string enum: - away - near - name: assignee_proximity__in required: false in: query description: assignee_proximity__in schema: type: string - 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: cancelled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: cancelled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: cancelled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: category required: false in: query description: category schema: type: string enum: - assignment - pick_up - drop_off - warehouse - name: category__in required: false in: query description: category__in schema: type: string - name: complete_after__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: contact__company__icontains required: false in: query description: contact__company__icontains schema: type: string - name: contact__company__in required: false in: query description: contact__company__in schema: type: string - name: contact__company__iregex required: false in: query description: contact__company__iregex schema: type: string - name: contact__company__istartswith required: false in: query description: contact__company__istartswith schema: type: string - name: contact__company__search required: false in: query description: contact__company__search schema: type: string - name: contact__email required: false in: query description: contact__email schema: type: string - name: contact__email__icontains required: false in: query description: contact__email__icontains schema: type: string - name: contact__email__in required: false in: query description: contact__email__in schema: type: string - name: contact__email__iregex required: false in: query description: contact__email__iregex schema: type: string - name: contact__email__istartswith required: false in: query description: contact__email__istartswith schema: type: string - name: contact__email__search required: false in: query description: 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 - name: contact__name required: false in: query description: contact__name schema: type: string - name: contact__name__icontains required: false in: query description: contact__name__icontains schema: type: string - name: contact__name__in required: false in: query description: contact__name__in schema: type: string - name: contact__name__iregex required: false in: query description: contact__name__iregex schema: type: string - name: contact__name__istartswith required: false in: query description: contact__name__istartswith schema: type: string - name: contact__name__search required: false in: query description: contact__name__search schema: type: string - name: contact__notes required: false in: query description: contact__notes schema: type: string - name: contact__notes__icontains required: false in: query description: contact__notes__icontains schema: type: string - name: contact__notes__in required: false in: query description: contact__notes__in schema: type: string - name: contact__notes__iregex required: false in: query description: contact__notes__iregex schema: type: string - name: contact__notes__istartswith required: false in: query description: contact__notes__istartswith schema: type: string - name: contact__notes__search required: false in: query description: contact__notes__search schema: type: string - name: contact__phone required: false in: query description: contact__phone schema: type: string - name: contact__phone__icontains required: false in: query description: contact__phone__icontains schema: type: string - name: contact__phone__in required: false in: query description: contact__phone__in schema: type: string - name: contact__phone__iregex required: false in: query description: contact__phone__iregex schema: type: string - name: contact__phone__istartswith required: false in: query description: contact__phone__istartswith schema: type: string - name: contact__phone__search required: false in: query description: 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_data required: false in: query description: Django ORM lookups can be used. Metafield `is_searchable` must be True. schema: type: string - name: contact_id required: false in: query description: contact_id schema: type: string - name: contact_id__in required: false in: query description: contact_id__in schema: type: string - name: contact_id__isnull required: false in: query description: contact_id__isnull schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_by required: false in: query description: created_by schema: type: string - name: created_by__in required: false in: query description: created_by__in schema: type: string - name: created_by__isnull required: false in: query description: created_by__isnull schema: type: string - name: description required: false in: query description: description schema: type: string - name: description__icontains required: false in: query description: description__icontains schema: type: string - name: description__iregex required: false in: query description: description__iregex schema: type: string - name: description__istartswith required: false in: query description: description__istartswith schema: type: string - name: description__search required: false in: query description: description__search schema: type: string - name: duration required: false in: query description: duration schema: type: string - name: duration__gt required: false in: query description: duration__gt schema: type: string - name: duration__gte required: false in: query description: duration__gte schema: type: string - name: duration__lt required: false in: query description: duration__lt schema: type: string - name: duration__lte required: false in: query description: duration__lte schema: type: string - name: external_id required: false in: query description: external_id schema: type: string - name: external_id__icontains required: false in: query description: external_id__icontains schema: type: string - name: external_id__in required: false in: query description: external_id__in schema: type: string - name: external_id__iregex required: false in: query description: external_id__iregex schema: type: string - name: external_id__isnull required: false in: query description: external_id__isnull schema: type: string - name: external_id__istartswith required: false in: query description: external_id__istartswith schema: type: string - name: external_id__search required: false in: query description: 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 - name: id required: false in: query description: id schema: type: string - name: id__in required: false in: query description: id__in schema: type: string - name: is_optimal required: false in: query description: is_optimal schema: type: string - name: is_optimal__isnull required: false in: query description: is_optimal__isnull schema: type: string - name: metadata__accepted_distance required: false in: query description: metadata__accepted_distance schema: type: string - name: metadata__accepted_distance__gt required: false in: query description: metadata__accepted_distance__gt schema: type: string - name: metadata__accepted_distance__gte required: false in: query description: metadata__accepted_distance__gte schema: type: string - name: metadata__accepted_distance__lt required: false in: query description: metadata__accepted_distance__lt schema: type: string - name: metadata__accepted_distance__lte required: false in: query description: metadata__accepted_distance__lte schema: type: string - name: metadata__accepted_duration required: false in: query description: metadata__accepted_duration schema: type: string - name: metadata__accepted_duration__gt required: false in: query description: metadata__accepted_duration__gt schema: type: string - name: metadata__accepted_duration__gte required: false in: query description: metadata__accepted_duration__gte schema: type: string - name: metadata__accepted_duration__lt required: false in: query description: metadata__accepted_duration__lt schema: type: string - name: metadata__accepted_duration__lte required: false in: query description: metadata__accepted_duration__lte schema: type: string - name: metadata__active_distance required: false in: query description: metadata__active_distance schema: type: string - name: metadata__active_distance__gt required: false in: query description: metadata__active_distance__gt schema: type: string - name: metadata__active_distance__gte required: false in: query description: metadata__active_distance__gte schema: type: string - name: metadata__active_distance__lt required: false in: query description: metadata__active_distance__lt schema: type: string - name: metadata__active_distance__lte required: false in: query description: metadata__active_distance__lte schema: type: string - name: metadata__active_duration required: false in: query description: metadata__active_duration schema: type: string - name: metadata__active_duration__gt required: false in: query description: metadata__active_duration__gt schema: type: string - name: metadata__active_duration__gte required: false in: query description: metadata__active_duration__gte schema: type: string - name: metadata__active_duration__lt required: false in: query description: metadata__active_duration__lt schema: type: string - name: metadata__active_duration__lte required: false in: query description: metadata__active_duration__lte schema: type: string - name: metadata__assigned_distance required: false in: query description: metadata__assigned_distance schema: type: string - name: metadata__assigned_distance__gt required: false in: query description: metadata__assigned_distance__gt schema: type: string - name: metadata__assigned_distance__gte required: false in: query description: metadata__assigned_distance__gte schema: type: string - name: metadata__assigned_distance__lt required: false in: query description: metadata__assigned_distance__lt schema: type: string - name: metadata__assigned_distance__lte required: false in: query description: metadata__assigned_distance__lte schema: type: string - name: metadata__assigned_duration required: false in: query description: metadata__assigned_duration schema: type: string - name: metadata__assigned_duration__gt required: false in: query description: metadata__assigned_duration__gt schema: type: string - name: metadata__assigned_duration__gte required: false in: query description: metadata__assigned_duration__gte schema: type: string - name: metadata__assigned_duration__lt required: false in: query description: metadata__assigned_duration__lt schema: type: string - name: metadata__assigned_duration__lte required: false in: query description: metadata__assigned_duration__lte schema: type: string - name: metadata__cancelled_distance required: false in: query description: metadata__cancelled_distance schema: type: string - name: metadata__cancelled_distance__gt required: false in: query description: metadata__cancelled_distance__gt schema: type: string - name: metadata__cancelled_distance__gte required: false in: query description: metadata__cancelled_distance__gte schema: type: string - name: metadata__cancelled_distance__lt required: false in: query description: metadata__cancelled_distance__lt schema: type: string - name: metadata__cancelled_distance__lte required: false in: query description: metadata__cancelled_distance__lte schema: type: string - name: metadata__cancelled_duration required: false in: query description: metadata__cancelled_duration schema: type: string - name: metadata__cancelled_duration__gt required: false in: query description: metadata__cancelled_duration__gt schema: type: string - name: metadata__cancelled_duration__gte required: false in: query description: metadata__cancelled_duration__gte schema: type: string - name: metadata__cancelled_duration__lt required: false in: query description: metadata__cancelled_duration__lt schema: type: string - name: metadata__cancelled_duration__lte required: false in: query description: metadata__cancelled_duration__lte schema: type: string - name: metadata__completed_distance required: false in: query description: metadata__completed_distance schema: type: string - name: metadata__completed_distance__gt required: false in: query description: metadata__completed_distance__gt schema: type: string - name: metadata__completed_distance__gte required: false in: query description: metadata__completed_distance__gte schema: type: string - name: metadata__completed_distance__lt required: false in: query description: metadata__completed_distance__lt schema: type: string - name: metadata__completed_distance__lte required: false in: query description: metadata__completed_distance__lte schema: type: string - name: metadata__completed_duration required: false in: query description: metadata__completed_duration schema: type: string - name: metadata__completed_duration__gt required: false in: query description: metadata__completed_duration__gt schema: type: string - name: metadata__completed_duration__gte required: false in: query description: metadata__completed_duration__gte schema: type: string - name: metadata__completed_duration__lt required: false in: query description: metadata__completed_duration__lt schema: type: string - name: metadata__completed_duration__lte required: false in: query description: metadata__completed_duration__lte schema: type: string - name: metadata__documents_count required: false in: query description: metadata__documents_count schema: type: string - name: metadata__documents_count__gt required: false in: query description: metadata__documents_count__gt schema: type: string - name: metadata__documents_count__gte required: false in: query description: metadata__documents_count__gte schema: type: string - name: metadata__documents_count__lt required: false in: query description: metadata__documents_count__lt schema: type: string - name: metadata__documents_count__lte required: false in: query description: metadata__documents_count__lte schema: type: string - name: metadata__events_count required: false in: query description: metadata__events_count schema: type: string - name: metadata__events_count__gt required: false in: query description: metadata__events_count__gt schema: type: string - name: metadata__events_count__gte required: false in: query description: metadata__events_count__gte schema: type: string - name: metadata__events_count__lt required: false in: query description: metadata__events_count__lt schema: type: string - name: metadata__events_count__lte required: false in: query description: metadata__events_count__lte schema: type: string - name: metadata__failed_distance required: false in: query description: metadata__failed_distance schema: type: string - name: metadata__failed_distance__gt required: false in: query description: metadata__failed_distance__gt schema: type: string - name: metadata__failed_distance__gte required: false in: query description: metadata__failed_distance__gte schema: type: string - name: metadata__failed_distance__lt required: false in: query description: metadata__failed_distance__lt schema: type: string - name: metadata__failed_distance__lte required: false in: query description: metadata__failed_distance__lte schema: type: string - name: metadata__failed_duration required: false in: query description: metadata__failed_duration schema: type: string - name: metadata__failed_duration__gt required: false in: query description: metadata__failed_duration__gt schema: type: string - name: metadata__failed_duration__gte required: false in: query description: metadata__failed_duration__gte schema: type: string - name: metadata__failed_duration__lt required: false in: query description: metadata__failed_duration__lt schema: type: string - name: metadata__failed_duration__lte required: false in: query description: metadata__failed_duration__lte schema: type: string - name: metadata__forms_completed_count required: false in: query description: metadata__forms_completed_count schema: type: string - name: metadata__forms_completed_count__gt required: false in: query description: metadata__forms_completed_count__gt schema: type: string - name: metadata__forms_completed_count__gte required: false in: query description: metadata__forms_completed_count__gte schema: type: string - name: metadata__forms_completed_count__lt required: false in: query description: metadata__forms_completed_count__lt schema: type: string - name: metadata__forms_completed_count__lte required: false in: query description: metadata__forms_completed_count__lte schema: type: string - name: metadata__forms_count required: false in: query description: metadata__forms_count schema: type: string - name: metadata__forms_count__gt required: false in: query description: metadata__forms_count__gt schema: type: string - name: metadata__forms_count__gte required: false in: query description: metadata__forms_count__gte schema: type: string - name: metadata__forms_count__lt required: false in: query description: metadata__forms_count__lt schema: type: string - name: metadata__forms_count__lte required: false in: query description: metadata__forms_count__lte schema: type: string - name: metadata__last_accepted_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_accepted_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_accepted_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_active_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_active_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_assigned_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_assigned_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_cancelled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_cancelled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_transit_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_transit_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_unassigned_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_unassigned_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__signatures_count required: false in: query description: metadata__signatures_count schema: type: string - name: metadata__signatures_count__gt required: false in: query description: metadata__signatures_count__gt schema: type: string - name: metadata__signatures_count__gte required: false in: query description: metadata__signatures_count__gte schema: type: string - name: metadata__signatures_count__lt required: false in: query description: metadata__signatures_count__lt schema: type: string - name: metadata__signatures_count__lte required: false in: query description: metadata__signatures_count__lte schema: type: string - name: metadata__task_event_notes_count required: false in: query description: metadata__task_event_notes_count schema: type: string - name: metadata__task_event_notes_count__gt required: false in: query description: metadata__task_event_notes_count__gt schema: type: string - name: metadata__task_event_notes_count__gte required: false in: query description: metadata__task_event_notes_count__gte schema: type: string - name: metadata__task_event_notes_count__lt required: false in: query description: metadata__task_event_notes_count__lt schema: type: string - name: metadata__task_event_notes_count__lte required: false in: query description: metadata__task_event_notes_count__lte schema: type: string - name: metadata__transit_distance required: false in: query description: metadata__transit_distance schema: type: string - name: metadata__transit_distance__gt required: false in: query description: metadata__transit_distance__gt schema: type: string - name: metadata__transit_distance__gte required: false in: query description: metadata__transit_distance__gte schema: type: string - name: metadata__transit_distance__lt required: false in: query description: metadata__transit_distance__lt schema: type: string - name: metadata__transit_distance__lte required: false in: query description: metadata__transit_distance__lte schema: type: string - name: metadata__transit_duration required: false in: query description: metadata__transit_duration schema: type: string - name: metadata__transit_duration__gt required: false in: query description: metadata__transit_duration__gt schema: type: string - name: metadata__transit_duration__gte required: false in: query description: metadata__transit_duration__gte schema: type: string - name: metadata__transit_duration__lt required: false in: query description: metadata__transit_duration__lt schema: type: string - name: metadata__transit_duration__lte required: false in: query description: metadata__transit_duration__lte schema: type: string - name: metadata__unassigned_distance required: false in: query description: metadata__unassigned_distance schema: type: string - name: metadata__unassigned_distance__gt required: false in: query description: metadata__unassigned_distance__gt schema: type: string - name: metadata__unassigned_distance__gte required: false in: query description: metadata__unassigned_distance__gte schema: type: string - name: metadata__unassigned_distance__lt required: false in: query description: metadata__unassigned_distance__lt schema: type: string - name: metadata__unassigned_distance__lte required: false in: query description: metadata__unassigned_distance__lte schema: type: string - name: metadata__unassigned_duration required: false in: query description: metadata__unassigned_duration schema: type: string - name: metadata__unassigned_duration__gt required: false in: query description: metadata__unassigned_duration__gt schema: type: string - name: metadata__unassigned_duration__gte required: false in: query description: metadata__unassigned_duration__gte schema: type: string - name: metadata__unassigned_duration__lt required: false in: query description: metadata__unassigned_duration__lt schema: type: string - name: metadata__unassigned_duration__lte required: false in: query description: metadata__unassigned_duration__lte schema: type: string - 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 - name: order__auto_assign required: false in: query description: order__auto_assign schema: type: string - name: order__created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: order__created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: order__created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_by required: false in: query description: order__created_by schema: type: string - name: order__created_by__in required: false in: query description: order__created_by__in schema: type: string - name: order__created_by__isnull required: false in: query description: order__created_by__isnull schema: type: string - name: order__external_id required: false in: query description: order__external_id schema: type: string - name: order__external_id__icontains required: false in: query description: order__external_id__icontains schema: type: string - name: order__external_id__in required: false in: query description: order__external_id__in schema: type: string - name: order__external_id__iregex required: false in: query description: order__external_id__iregex schema: type: string - name: order__external_id__isnull required: false in: query description: order__external_id__isnull schema: type: string - name: order__external_id__istartswith required: false in: query description: order__external_id__istartswith schema: type: string - name: order__external_id__search required: false in: query description: 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 - name: order__reference required: false in: query description: order__reference schema: type: string - name: order__reference__icontains required: false in: query description: order__reference__icontains schema: type: string - name: order__reference__in required: false in: query description: order__reference__in schema: type: string - name: order__reference__iregex required: false in: query description: order__reference__iregex schema: type: string - name: order__reference__istartswith required: false in: query description: order__reference__istartswith schema: type: string - name: order__reference__search required: false in: query description: order__reference__search schema: type: string - name: order_id required: false in: query description: order_id schema: type: string - name: order_id__in required: false in: query description: order_id__in schema: type: string - name: order_id__isnull required: false in: query description: order_id__isnull schema: type: string - name: orderer required: false in: query schema: type: string format: uuid - name: orderer__id required: false in: query description: orderer__id schema: type: string - name: orderer__id__in required: false in: query description: orderer__id__in schema: type: string - name: orderer__id__isnull required: false in: query description: orderer__id__isnull schema: type: string - name: orderer__in required: false in: query description: comma separated value schema: type: string - name: orderer__name required: false in: query description: orderer__name schema: type: string - name: orderer__name__icontains required: false in: query description: orderer__name__icontains schema: type: string - name: orderer_id required: false in: query description: orderer_id schema: type: string - name: orderer_id__in required: false in: query description: orderer_id__in schema: type: string - name: orderer_id__isnull required: false in: query description: orderer_id__isnull schema: type: string - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: owner_id required: false in: query description: owner_id schema: type: string - name: owner_id__in required: false in: query description: owner_id__in schema: type: string - name: owner_id__isnull required: false in: query description: owner_id__isnull 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: position__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: 1329af07-9fb7-4b2d-925c-3f3e5f64d812,6728e86b-64e4-49af-a1f4-6720f884a3c3 - 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: 1329af07-9fb7-4b2d-925c-3f3e5f64d812,6728e86b-64e4-49af-a1f4-6720f884a3c3 - 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: 1329af07-9fb7-4b2d-925c-3f3e5f64d812,6728e86b-64e4-49af-a1f4-6720f884a3c3 - name: priority required: false in: query description: priority schema: type: string - name: priority__gt required: false in: query description: priority__gt schema: type: string - name: priority__gte required: false in: query description: priority__gte schema: type: string - name: priority__in required: false in: query description: priority__in schema: type: string - name: priority__lt required: false in: query description: priority__lt schema: type: string - name: priority__lte required: false in: query description: priority__lte schema: type: string - 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 - name: receiver_id required: false in: query description: receiver_id schema: type: string - name: receiver_id__in required: false in: query description: receiver_id__in schema: type: string - name: receiver_id__isnull required: false in: query description: receiver_id__isnull schema: type: string - name: reference required: false in: query description: reference schema: type: string - name: reference__icontains required: false in: query description: reference__icontains schema: type: string - name: reference__in required: false in: query description: reference__in schema: type: string - name: reference__iregex required: false in: query description: reference__iregex schema: type: string - name: reference__istartswith required: false in: query description: reference__istartswith schema: type: string - name: reference__search required: false in: query description: reference__search schema: type: string - name: route required: false in: query schema: type: string format: uuid - name: route__in required: false in: query description: comma separated value schema: type: string - name: route_id required: false in: query description: route_id schema: type: string - name: route_id__in required: false in: query description: route_id__in schema: type: string - name: route_id__isnull required: false in: query description: route_id__isnull schema: type: string - name: scheduled_time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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 - name: state required: false in: query description: state schema: type: string enum: - unassigned - assigned - accepted - transit - active - completed - failed - 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 - name: unassignee_id required: false in: query description: unassignee_id schema: type: string - name: unassignee_id__in required: false in: query description: unassignee_id__in schema: type: string - name: unassignee_id__isnull required: false in: query description: unassignee_id__isnull schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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.4.13: schema: $ref: '#/components/schemas/PaginatedTaskExportList' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskExportList' description: '' /task_forms/: get: operationId: task_forms_list parameters: - name: completed required: false in: query description: completed schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: task required: false in: query description: task schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - task_forms security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskFormList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskFormList' description: '' post: operationId: task_forms_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - task_forms requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskForm' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TaskForm' multipart/form-data: schema: $ref: '#/components/schemas/TaskForm' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskForm' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TaskForm' description: '' /task_forms/{id}/: get: operationId: task_forms_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/TaskForm' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TaskForm' description: '' put: operationId: task_forms_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TaskForm' multipart/form-data: schema: $ref: '#/components/schemas/TaskForm' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskForm' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TaskForm' description: '' patch: operationId: task_forms_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTaskForm' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTaskForm' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskForm' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TaskForm' description: '' delete: operationId: task_forms_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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: - name: account required: false in: query description: account schema: type: string - name: completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: started_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: started_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: started_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: started_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: state required: false in: query description: state schema: type: string enum: - pending - started - completed - failed - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - task_import security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTasksBackgroundImportList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTasksBackgroundImportList' description: '' post: operationId: task_import_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - task_import requestBody: content: application/json: schema: $ref: '#/components/schemas/TasksBackgroundImport' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TasksBackgroundImport' multipart/form-data: schema: $ref: '#/components/schemas/TasksBackgroundImport' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TasksBackgroundImport' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TasksBackgroundImport' description: '' /task_import/{id}/: get: operationId: task_import_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/TasksBackgroundImport' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TasksBackgroundImport' description: '' /task_import_mapping/: get: operationId: task_import_mapping_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - 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 - in: query name: format schema: type: string enum: - json - xlsx - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - task_import_mapping security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedImportMappingList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedImportMappingList' description: '' post: operationId: task_import_mapping_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - task_import_mapping requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportMapping' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImportMapping' multipart/form-data: schema: $ref: '#/components/schemas/ImportMapping' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/ImportMapping' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ImportMapping' description: '' /task_import_mapping/{id}/: get: operationId: task_import_mapping_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/ImportMapping' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/ImportMapping' description: '' /task_metadatas/: get: operationId: task_metadatas_list parameters: - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: task required: false in: query description: task schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - task_metadatas security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskMetadataList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskMetadataList' description: '' /task_metadatas/{id}/: get: operationId: task_metadatas_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/TaskMetadata' application/xlsx; version=2.4.13: 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 - name: address__apartment_number required: false in: query description: address__apartment_number schema: type: string - name: address__apartment_number__icontains required: false in: query description: address__apartment_number__icontains schema: type: string - name: address__apartment_number__in required: false in: query description: address__apartment_number__in schema: type: string - name: address__apartment_number__iregex required: false in: query description: address__apartment_number__iregex schema: type: string - name: address__apartment_number__istartswith required: false in: query description: address__apartment_number__istartswith schema: type: string - name: address__apartment_number__search required: false in: query description: address__apartment_number__search schema: type: string - name: address__city required: false in: query description: address__city schema: type: string - name: address__city__icontains required: false in: query description: address__city__icontains schema: type: string - name: address__city__in required: false in: query description: address__city__in schema: type: string - name: address__city__iregex required: false in: query description: address__city__iregex schema: type: string - name: address__city__istartswith required: false in: query description: address__city__istartswith schema: type: string - name: address__city__search required: false in: query description: address__city__search schema: type: string - name: address__country required: false in: query description: address__country schema: type: string - name: address__country__icontains required: false in: query description: address__country__icontains schema: type: string - name: address__country__in required: false in: query description: address__country__in schema: type: string - name: address__country__iregex required: false in: query description: address__country__iregex schema: type: string - name: address__country__istartswith required: false in: query description: address__country__istartswith schema: type: string - name: address__country__search required: false in: query description: address__country__search schema: type: string - name: address__country_code required: false in: query description: address__country_code schema: type: string - name: address__country_code__icontains required: false in: query description: address__country_code__icontains schema: type: string - name: address__country_code__in required: false in: query description: address__country_code__in schema: type: string - name: address__country_code__iregex required: false in: query description: address__country_code__iregex schema: type: string - name: address__country_code__istartswith required: false in: query description: address__country_code__istartswith schema: type: string - name: address__country_code__search required: false in: query description: address__country_code__search schema: type: string - name: address__formatted_address required: false in: query description: address__formatted_address schema: type: string - name: address__formatted_address__icontains required: false in: query description: address__formatted_address__icontains schema: type: string - name: address__formatted_address__in required: false in: query description: address__formatted_address__in schema: type: string - name: address__formatted_address__iregex required: false in: query description: address__formatted_address__iregex schema: type: string - name: address__formatted_address__istartswith required: false in: query description: address__formatted_address__istartswith schema: type: string - name: address__formatted_address__search required: false in: query description: address__formatted_address__search schema: type: string - name: address__geocode_failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocode_failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocode_failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocode_failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocoded_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: address__geocoded_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__geocoded_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: address__google_place_id required: false in: query description: address__google_place_id schema: type: string - name: address__google_place_id__icontains required: false in: query description: address__google_place_id__icontains schema: type: string - name: address__google_place_id__in required: false in: query description: address__google_place_id__in schema: type: string - name: address__google_place_id__iregex required: false in: query description: address__google_place_id__iregex schema: type: string - name: address__google_place_id__istartswith required: false in: query description: address__google_place_id__istartswith schema: type: string - name: address__google_place_id__search required: false in: query description: address__google_place_id__search schema: type: string - name: address__house_number required: false in: query description: address__house_number schema: type: string - name: address__house_number__icontains required: false in: query description: address__house_number__icontains schema: type: string - name: address__house_number__in required: false in: query description: address__house_number__in schema: type: string - name: address__house_number__iregex required: false in: query description: address__house_number__iregex schema: type: string - name: address__house_number__istartswith required: false in: query description: address__house_number__istartswith schema: type: string - name: address__house_number__search required: false in: query description: address__house_number__search schema: type: string - name: address__point_of_interest required: false in: query description: address__point_of_interest schema: type: string - name: address__point_of_interest__icontains required: false in: query description: address__point_of_interest__icontains schema: type: string - name: address__point_of_interest__in required: false in: query description: address__point_of_interest__in schema: type: string - name: address__point_of_interest__iregex required: false in: query description: address__point_of_interest__iregex schema: type: string - name: address__point_of_interest__istartswith required: false in: query description: address__point_of_interest__istartswith schema: type: string - name: address__point_of_interest__search required: false in: query description: address__point_of_interest__search schema: type: string - name: address__postal_code required: false in: query description: address__postal_code schema: type: string - name: address__postal_code__icontains required: false in: query description: address__postal_code__icontains schema: type: string - name: address__postal_code__in required: false in: query description: address__postal_code__in schema: type: string - name: address__postal_code__iregex required: false in: query description: address__postal_code__iregex schema: type: string - name: address__postal_code__istartswith required: false in: query description: address__postal_code__istartswith schema: type: string - name: address__postal_code__search required: false in: query description: address__postal_code__search schema: type: string - name: address__raw_address required: false in: query description: address__raw_address schema: type: string - name: address__raw_address__icontains required: false in: query description: address__raw_address__icontains schema: type: string - name: address__raw_address__in required: false in: query description: address__raw_address__in schema: type: string - name: address__raw_address__iregex required: false in: query description: address__raw_address__iregex schema: type: string - name: address__raw_address__istartswith required: false in: query description: address__raw_address__istartswith schema: type: string - name: address__raw_address__search required: false in: query description: address__raw_address__search schema: type: string - name: address__state required: false in: query description: address__state schema: type: string - name: address__state__icontains required: false in: query description: address__state__icontains schema: type: string - name: address__state__in required: false in: query description: address__state__in schema: type: string - name: address__state__iregex required: false in: query description: address__state__iregex schema: type: string - name: address__state__istartswith required: false in: query description: address__state__istartswith schema: type: string - name: address__state__search required: false in: query description: address__state__search schema: type: string - name: address__street required: false in: query description: address__street schema: type: string - name: address__street__icontains required: false in: query description: address__street__icontains schema: type: string - name: address__street__in required: false in: query description: address__street__in schema: type: string - name: address__street__iregex required: false in: query description: address__street__iregex schema: type: string - name: address__street__istartswith required: false in: query description: address__street__istartswith schema: type: string - name: address__street__search required: false in: query description: 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 - name: address_id required: false in: query description: address_id schema: type: string - name: address_id__in required: false in: query description: address_id__in schema: type: string - name: address_id__isnull required: false in: query description: address_id__isnull schema: type: string - name: assignee required: false in: query schema: type: string format: uuid - name: assignee__email required: false in: query description: assignee__email schema: type: string - name: assignee__email__icontains required: false in: query description: assignee__email__icontains schema: type: string - name: assignee__email__iregex required: false in: query description: assignee__email__iregex schema: type: string - name: assignee__email__isnull required: false in: query description: assignee__email__isnull schema: type: string - name: assignee__email__istartswith required: false in: query description: assignee__email__istartswith schema: type: string - name: assignee__email__search required: false in: query description: assignee__email__search schema: type: string - name: assignee__first_name required: false in: query description: assignee__first_name schema: type: string - name: assignee__first_name__icontains required: false in: query description: assignee__first_name__icontains schema: type: string - name: assignee__first_name__iregex required: false in: query description: assignee__first_name__iregex schema: type: string - name: assignee__first_name__isnull required: false in: query description: assignee__first_name__isnull schema: type: string - name: assignee__first_name__istartswith required: false in: query description: assignee__first_name__istartswith schema: type: string - name: assignee__first_name__search required: false in: query description: assignee__first_name__search schema: type: string - name: assignee__in required: false in: query description: comma separated value schema: type: string - name: assignee__last_name required: false in: query description: assignee__last_name schema: type: string - name: assignee__last_name__icontains required: false in: query description: assignee__last_name__icontains schema: type: string - name: assignee__last_name__iregex required: false in: query description: assignee__last_name__iregex schema: type: string - name: assignee__last_name__isnull required: false in: query description: assignee__last_name__isnull schema: type: string - name: assignee__last_name__istartswith required: false in: query description: assignee__last_name__istartswith schema: type: string - name: assignee__last_name__search required: false in: query description: assignee__last_name__search schema: type: string - name: assignee__phone required: false in: query description: assignee__phone schema: type: string - name: assignee__phone__icontains required: false in: query description: assignee__phone__icontains schema: type: string - name: assignee__phone__iregex required: false in: query description: assignee__phone__iregex schema: type: string - name: assignee__phone__isnull required: false in: query description: assignee__phone__isnull schema: type: string - name: assignee__phone__istartswith required: false in: query description: assignee__phone__istartswith schema: type: string - name: assignee__phone__search required: false in: query description: assignee__phone__search schema: type: string - name: assignee_id required: false in: query description: assignee_id schema: type: string - name: assignee_id__in required: false in: query description: assignee_id__in schema: type: string - name: assignee_id__isnull required: false in: query description: assignee_id__isnull schema: type: string - name: assignee_proximity required: false in: query description: assignee_proximity schema: type: string enum: - away - near - name: assignee_proximity__in required: false in: query description: assignee_proximity__in schema: type: string - 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: cancelled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: cancelled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: cancelled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cancelled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: category required: false in: query description: category schema: type: string enum: - assignment - pick_up - drop_off - warehouse - name: category__in required: false in: query description: category__in schema: type: string - name: complete_after__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_after__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_after__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: complete_before__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: complete_before__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: contact__company__icontains required: false in: query description: contact__company__icontains schema: type: string - name: contact__company__in required: false in: query description: contact__company__in schema: type: string - name: contact__company__iregex required: false in: query description: contact__company__iregex schema: type: string - name: contact__company__istartswith required: false in: query description: contact__company__istartswith schema: type: string - name: contact__company__search required: false in: query description: contact__company__search schema: type: string - name: contact__email required: false in: query description: contact__email schema: type: string - name: contact__email__icontains required: false in: query description: contact__email__icontains schema: type: string - name: contact__email__in required: false in: query description: contact__email__in schema: type: string - name: contact__email__iregex required: false in: query description: contact__email__iregex schema: type: string - name: contact__email__istartswith required: false in: query description: contact__email__istartswith schema: type: string - name: contact__email__search required: false in: query description: 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 - name: contact__name required: false in: query description: contact__name schema: type: string - name: contact__name__icontains required: false in: query description: contact__name__icontains schema: type: string - name: contact__name__in required: false in: query description: contact__name__in schema: type: string - name: contact__name__iregex required: false in: query description: contact__name__iregex schema: type: string - name: contact__name__istartswith required: false in: query description: contact__name__istartswith schema: type: string - name: contact__name__search required: false in: query description: contact__name__search schema: type: string - name: contact__notes required: false in: query description: contact__notes schema: type: string - name: contact__notes__icontains required: false in: query description: contact__notes__icontains schema: type: string - name: contact__notes__in required: false in: query description: contact__notes__in schema: type: string - name: contact__notes__iregex required: false in: query description: contact__notes__iregex schema: type: string - name: contact__notes__istartswith required: false in: query description: contact__notes__istartswith schema: type: string - name: contact__notes__search required: false in: query description: contact__notes__search schema: type: string - name: contact__phone required: false in: query description: contact__phone schema: type: string - name: contact__phone__icontains required: false in: query description: contact__phone__icontains schema: type: string - name: contact__phone__in required: false in: query description: contact__phone__in schema: type: string - name: contact__phone__iregex required: false in: query description: contact__phone__iregex schema: type: string - name: contact__phone__istartswith required: false in: query description: contact__phone__istartswith schema: type: string - name: contact__phone__search required: false in: query description: 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_data required: false in: query description: Django ORM lookups can be used. Metafield `is_searchable` must be True. schema: type: string - name: contact_id required: false in: query description: contact_id schema: type: string - name: contact_id__in required: false in: query description: contact_id__in schema: type: string - name: contact_id__isnull required: false in: query description: contact_id__isnull schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_by required: false in: query description: created_by schema: type: string - name: created_by__in required: false in: query description: created_by__in schema: type: string - name: created_by__isnull required: false in: query description: created_by__isnull schema: type: string - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: description required: false in: query description: description schema: type: string - name: description__icontains required: false in: query description: description__icontains schema: type: string - name: description__iregex required: false in: query description: description__iregex schema: type: string - name: description__istartswith required: false in: query description: description__istartswith schema: type: string - name: description__search required: false in: query description: description__search schema: type: string - name: duration required: false in: query description: duration schema: type: string - name: duration__gt required: false in: query description: duration__gt schema: type: string - name: duration__gte required: false in: query description: duration__gte schema: type: string - name: duration__lt required: false in: query description: duration__lt schema: type: string - name: duration__lte required: false in: query description: duration__lte schema: type: string - name: external_id required: false in: query description: external_id schema: type: string - name: external_id__icontains required: false in: query description: external_id__icontains schema: type: string - name: external_id__in required: false in: query description: external_id__in schema: type: string - name: external_id__iregex required: false in: query description: external_id__iregex schema: type: string - name: external_id__isnull required: false in: query description: external_id__isnull schema: type: string - name: external_id__istartswith required: false in: query description: external_id__istartswith schema: type: string - name: external_id__search required: false in: query description: external_id__search schema: type: string - in: query name: format schema: type: string enum: - json - xml - name: id required: false in: query description: id schema: type: string - name: id__in required: false in: query description: id__in schema: type: string - name: is_optimal required: false in: query description: is_optimal schema: type: string - name: is_optimal__isnull required: false in: query description: is_optimal__isnull schema: type: string - name: metadata__accepted_distance required: false in: query description: metadata__accepted_distance schema: type: string - name: metadata__accepted_distance__gt required: false in: query description: metadata__accepted_distance__gt schema: type: string - name: metadata__accepted_distance__gte required: false in: query description: metadata__accepted_distance__gte schema: type: string - name: metadata__accepted_distance__lt required: false in: query description: metadata__accepted_distance__lt schema: type: string - name: metadata__accepted_distance__lte required: false in: query description: metadata__accepted_distance__lte schema: type: string - name: metadata__accepted_duration required: false in: query description: metadata__accepted_duration schema: type: string - name: metadata__accepted_duration__gt required: false in: query description: metadata__accepted_duration__gt schema: type: string - name: metadata__accepted_duration__gte required: false in: query description: metadata__accepted_duration__gte schema: type: string - name: metadata__accepted_duration__lt required: false in: query description: metadata__accepted_duration__lt schema: type: string - name: metadata__accepted_duration__lte required: false in: query description: metadata__accepted_duration__lte schema: type: string - name: metadata__active_distance required: false in: query description: metadata__active_distance schema: type: string - name: metadata__active_distance__gt required: false in: query description: metadata__active_distance__gt schema: type: string - name: metadata__active_distance__gte required: false in: query description: metadata__active_distance__gte schema: type: string - name: metadata__active_distance__lt required: false in: query description: metadata__active_distance__lt schema: type: string - name: metadata__active_distance__lte required: false in: query description: metadata__active_distance__lte schema: type: string - name: metadata__active_duration required: false in: query description: metadata__active_duration schema: type: string - name: metadata__active_duration__gt required: false in: query description: metadata__active_duration__gt schema: type: string - name: metadata__active_duration__gte required: false in: query description: metadata__active_duration__gte schema: type: string - name: metadata__active_duration__lt required: false in: query description: metadata__active_duration__lt schema: type: string - name: metadata__active_duration__lte required: false in: query description: metadata__active_duration__lte schema: type: string - name: metadata__assigned_distance required: false in: query description: metadata__assigned_distance schema: type: string - name: metadata__assigned_distance__gt required: false in: query description: metadata__assigned_distance__gt schema: type: string - name: metadata__assigned_distance__gte required: false in: query description: metadata__assigned_distance__gte schema: type: string - name: metadata__assigned_distance__lt required: false in: query description: metadata__assigned_distance__lt schema: type: string - name: metadata__assigned_distance__lte required: false in: query description: metadata__assigned_distance__lte schema: type: string - name: metadata__assigned_duration required: false in: query description: metadata__assigned_duration schema: type: string - name: metadata__assigned_duration__gt required: false in: query description: metadata__assigned_duration__gt schema: type: string - name: metadata__assigned_duration__gte required: false in: query description: metadata__assigned_duration__gte schema: type: string - name: metadata__assigned_duration__lt required: false in: query description: metadata__assigned_duration__lt schema: type: string - name: metadata__assigned_duration__lte required: false in: query description: metadata__assigned_duration__lte schema: type: string - name: metadata__cancelled_distance required: false in: query description: metadata__cancelled_distance schema: type: string - name: metadata__cancelled_distance__gt required: false in: query description: metadata__cancelled_distance__gt schema: type: string - name: metadata__cancelled_distance__gte required: false in: query description: metadata__cancelled_distance__gte schema: type: string - name: metadata__cancelled_distance__lt required: false in: query description: metadata__cancelled_distance__lt schema: type: string - name: metadata__cancelled_distance__lte required: false in: query description: metadata__cancelled_distance__lte schema: type: string - name: metadata__cancelled_duration required: false in: query description: metadata__cancelled_duration schema: type: string - name: metadata__cancelled_duration__gt required: false in: query description: metadata__cancelled_duration__gt schema: type: string - name: metadata__cancelled_duration__gte required: false in: query description: metadata__cancelled_duration__gte schema: type: string - name: metadata__cancelled_duration__lt required: false in: query description: metadata__cancelled_duration__lt schema: type: string - name: metadata__cancelled_duration__lte required: false in: query description: metadata__cancelled_duration__lte schema: type: string - name: metadata__completed_distance required: false in: query description: metadata__completed_distance schema: type: string - name: metadata__completed_distance__gt required: false in: query description: metadata__completed_distance__gt schema: type: string - name: metadata__completed_distance__gte required: false in: query description: metadata__completed_distance__gte schema: type: string - name: metadata__completed_distance__lt required: false in: query description: metadata__completed_distance__lt schema: type: string - name: metadata__completed_distance__lte required: false in: query description: metadata__completed_distance__lte schema: type: string - name: metadata__completed_duration required: false in: query description: metadata__completed_duration schema: type: string - name: metadata__completed_duration__gt required: false in: query description: metadata__completed_duration__gt schema: type: string - name: metadata__completed_duration__gte required: false in: query description: metadata__completed_duration__gte schema: type: string - name: metadata__completed_duration__lt required: false in: query description: metadata__completed_duration__lt schema: type: string - name: metadata__completed_duration__lte required: false in: query description: metadata__completed_duration__lte schema: type: string - name: metadata__documents_count required: false in: query description: metadata__documents_count schema: type: string - name: metadata__documents_count__gt required: false in: query description: metadata__documents_count__gt schema: type: string - name: metadata__documents_count__gte required: false in: query description: metadata__documents_count__gte schema: type: string - name: metadata__documents_count__lt required: false in: query description: metadata__documents_count__lt schema: type: string - name: metadata__documents_count__lte required: false in: query description: metadata__documents_count__lte schema: type: string - name: metadata__events_count required: false in: query description: metadata__events_count schema: type: string - name: metadata__events_count__gt required: false in: query description: metadata__events_count__gt schema: type: string - name: metadata__events_count__gte required: false in: query description: metadata__events_count__gte schema: type: string - name: metadata__events_count__lt required: false in: query description: metadata__events_count__lt schema: type: string - name: metadata__events_count__lte required: false in: query description: metadata__events_count__lte schema: type: string - name: metadata__failed_distance required: false in: query description: metadata__failed_distance schema: type: string - name: metadata__failed_distance__gt required: false in: query description: metadata__failed_distance__gt schema: type: string - name: metadata__failed_distance__gte required: false in: query description: metadata__failed_distance__gte schema: type: string - name: metadata__failed_distance__lt required: false in: query description: metadata__failed_distance__lt schema: type: string - name: metadata__failed_distance__lte required: false in: query description: metadata__failed_distance__lte schema: type: string - name: metadata__failed_duration required: false in: query description: metadata__failed_duration schema: type: string - name: metadata__failed_duration__gt required: false in: query description: metadata__failed_duration__gt schema: type: string - name: metadata__failed_duration__gte required: false in: query description: metadata__failed_duration__gte schema: type: string - name: metadata__failed_duration__lt required: false in: query description: metadata__failed_duration__lt schema: type: string - name: metadata__failed_duration__lte required: false in: query description: metadata__failed_duration__lte schema: type: string - name: metadata__forms_completed_count required: false in: query description: metadata__forms_completed_count schema: type: string - name: metadata__forms_completed_count__gt required: false in: query description: metadata__forms_completed_count__gt schema: type: string - name: metadata__forms_completed_count__gte required: false in: query description: metadata__forms_completed_count__gte schema: type: string - name: metadata__forms_completed_count__lt required: false in: query description: metadata__forms_completed_count__lt schema: type: string - name: metadata__forms_completed_count__lte required: false in: query description: metadata__forms_completed_count__lte schema: type: string - name: metadata__forms_count required: false in: query description: metadata__forms_count schema: type: string - name: metadata__forms_count__gt required: false in: query description: metadata__forms_count__gt schema: type: string - name: metadata__forms_count__gte required: false in: query description: metadata__forms_count__gte schema: type: string - name: metadata__forms_count__lt required: false in: query description: metadata__forms_count__lt schema: type: string - name: metadata__forms_count__lte required: false in: query description: metadata__forms_count__lte schema: type: string - name: metadata__last_accepted_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_accepted_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_accepted_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_accepted_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_active_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_active_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_active_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_assigned_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_assigned_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_assigned_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_cancelled_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_cancelled_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_cancelled_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_completed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_completed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_completed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_failed_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_failed_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_failed_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_transit_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_transit_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_transit_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_unassigned_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: metadata__last_unassigned_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__last_unassigned_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: metadata__signatures_count required: false in: query description: metadata__signatures_count schema: type: string - name: metadata__signatures_count__gt required: false in: query description: metadata__signatures_count__gt schema: type: string - name: metadata__signatures_count__gte required: false in: query description: metadata__signatures_count__gte schema: type: string - name: metadata__signatures_count__lt required: false in: query description: metadata__signatures_count__lt schema: type: string - name: metadata__signatures_count__lte required: false in: query description: metadata__signatures_count__lte schema: type: string - name: metadata__task_event_notes_count required: false in: query description: metadata__task_event_notes_count schema: type: string - name: metadata__task_event_notes_count__gt required: false in: query description: metadata__task_event_notes_count__gt schema: type: string - name: metadata__task_event_notes_count__gte required: false in: query description: metadata__task_event_notes_count__gte schema: type: string - name: metadata__task_event_notes_count__lt required: false in: query description: metadata__task_event_notes_count__lt schema: type: string - name: metadata__task_event_notes_count__lte required: false in: query description: metadata__task_event_notes_count__lte schema: type: string - name: metadata__transit_distance required: false in: query description: metadata__transit_distance schema: type: string - name: metadata__transit_distance__gt required: false in: query description: metadata__transit_distance__gt schema: type: string - name: metadata__transit_distance__gte required: false in: query description: metadata__transit_distance__gte schema: type: string - name: metadata__transit_distance__lt required: false in: query description: metadata__transit_distance__lt schema: type: string - name: metadata__transit_distance__lte required: false in: query description: metadata__transit_distance__lte schema: type: string - name: metadata__transit_duration required: false in: query description: metadata__transit_duration schema: type: string - name: metadata__transit_duration__gt required: false in: query description: metadata__transit_duration__gt schema: type: string - name: metadata__transit_duration__gte required: false in: query description: metadata__transit_duration__gte schema: type: string - name: metadata__transit_duration__lt required: false in: query description: metadata__transit_duration__lt schema: type: string - name: metadata__transit_duration__lte required: false in: query description: metadata__transit_duration__lte schema: type: string - name: metadata__unassigned_distance required: false in: query description: metadata__unassigned_distance schema: type: string - name: metadata__unassigned_distance__gt required: false in: query description: metadata__unassigned_distance__gt schema: type: string - name: metadata__unassigned_distance__gte required: false in: query description: metadata__unassigned_distance__gte schema: type: string - name: metadata__unassigned_distance__lt required: false in: query description: metadata__unassigned_distance__lt schema: type: string - name: metadata__unassigned_distance__lte required: false in: query description: metadata__unassigned_distance__lte schema: type: string - name: metadata__unassigned_duration required: false in: query description: metadata__unassigned_duration schema: type: string - name: metadata__unassigned_duration__gt required: false in: query description: metadata__unassigned_duration__gt schema: type: string - name: metadata__unassigned_duration__gte required: false in: query description: metadata__unassigned_duration__gte schema: type: string - name: metadata__unassigned_duration__lt required: false in: query description: metadata__unassigned_duration__lt schema: type: string - name: metadata__unassigned_duration__lte required: false in: query description: metadata__unassigned_duration__lte schema: type: string - 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 - name: order__auto_assign required: false in: query description: order__auto_assign schema: type: string - name: order__created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: order__created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: order__created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: order__created_by required: false in: query description: order__created_by schema: type: string - name: order__created_by__in required: false in: query description: order__created_by__in schema: type: string - name: order__created_by__isnull required: false in: query description: order__created_by__isnull schema: type: string - name: order__external_id required: false in: query description: order__external_id schema: type: string - name: order__external_id__icontains required: false in: query description: order__external_id__icontains schema: type: string - name: order__external_id__in required: false in: query description: order__external_id__in schema: type: string - name: order__external_id__iregex required: false in: query description: order__external_id__iregex schema: type: string - name: order__external_id__isnull required: false in: query description: order__external_id__isnull schema: type: string - name: order__external_id__istartswith required: false in: query description: order__external_id__istartswith schema: type: string - name: order__external_id__search required: false in: query description: 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 - name: order__reference required: false in: query description: order__reference schema: type: string - name: order__reference__icontains required: false in: query description: order__reference__icontains schema: type: string - name: order__reference__in required: false in: query description: order__reference__in schema: type: string - name: order__reference__iregex required: false in: query description: order__reference__iregex schema: type: string - name: order__reference__istartswith required: false in: query description: order__reference__istartswith schema: type: string - name: order__reference__search required: false in: query description: order__reference__search schema: type: string - name: order_id required: false in: query description: order_id schema: type: string - name: order_id__in required: false in: query description: order_id__in schema: type: string - name: order_id__isnull required: false in: query description: order_id__isnull schema: type: string - name: orderer required: false in: query schema: type: string format: uuid - name: orderer__id required: false in: query description: orderer__id schema: type: string - name: orderer__id__in required: false in: query description: orderer__id__in schema: type: string - name: orderer__id__isnull required: false in: query description: orderer__id__isnull schema: type: string - name: orderer__in required: false in: query description: comma separated value schema: type: string - name: orderer__name required: false in: query description: orderer__name schema: type: string - name: orderer__name__icontains required: false in: query description: orderer__name__icontains schema: type: string - name: orderer_id required: false in: query description: orderer_id schema: type: string - name: orderer_id__in required: false in: query description: orderer_id__in schema: type: string - name: orderer_id__isnull required: false in: query description: orderer_id__isnull schema: type: string - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: owner_id required: false in: query description: owner_id schema: type: string - name: owner_id__in required: false in: query description: owner_id__in schema: type: string - name: owner_id__isnull required: false in: query description: owner_id__isnull schema: type: string - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: position__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: position__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: position__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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: a302e48a-bd04-4d36-b13e-38a77ec6701f,6cc0231a-c6bf-44c5-928f-82130830447c - 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: a302e48a-bd04-4d36-b13e-38a77ec6701f,6cc0231a-c6bf-44c5-928f-82130830447c - 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: a302e48a-bd04-4d36-b13e-38a77ec6701f,6cc0231a-c6bf-44c5-928f-82130830447c - name: priority required: false in: query description: priority schema: type: string - name: priority__gt required: false in: query description: priority__gt schema: type: string - name: priority__gte required: false in: query description: priority__gte schema: type: string - name: priority__in required: false in: query description: priority__in schema: type: string - name: priority__lt required: false in: query description: priority__lt schema: type: string - name: priority__lte required: false in: query description: priority__lte schema: type: string - 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 - name: receiver_id required: false in: query description: receiver_id schema: type: string - name: receiver_id__in required: false in: query description: receiver_id__in schema: type: string - name: receiver_id__isnull required: false in: query description: receiver_id__isnull schema: type: string - name: reference required: false in: query description: reference schema: type: string - name: reference__icontains required: false in: query description: reference__icontains schema: type: string - name: reference__in required: false in: query description: reference__in schema: type: string - name: reference__iregex required: false in: query description: reference__iregex schema: type: string - name: reference__istartswith required: false in: query description: reference__istartswith schema: type: string - name: reference__search required: false in: query description: reference__search schema: type: string - name: route required: false in: query schema: type: string format: uuid - name: route__in required: false in: query description: comma separated value schema: type: string - name: route_id required: false in: query description: route_id schema: type: string - name: route_id__in required: false in: query description: route_id__in schema: type: string - name: route_id__isnull required: false in: query description: route_id__isnull schema: type: string - name: scheduled_time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: scheduled_time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: scheduled_time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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 - name: state required: false in: query description: state schema: type: string enum: - unassigned - assigned - accepted - transit - active - completed - failed - 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 - name: unassignee_id required: false in: query description: unassignee_id schema: type: string - name: unassignee_id__in required: false in: query description: unassignee_id__in schema: type: string - name: unassignee_id__isnull required: false in: query description: unassignee_id__isnull schema: type: string - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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.4.13: schema: $ref: '#/components/schemas/PaginatedTaskSerializerV2List' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTaskSerializerV2List' description: '' post: operationId: tasks_create parameters: - in: query name: format schema: type: string enum: - json - xml - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml: schema: $ref: '#/components/schemas/TaskSerializerV2' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' description: '' /tasks/{id}/: get: operationId: tasks_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' description: '' put: operationId: tasks_update parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml: schema: $ref: '#/components/schemas/TaskSerializerV2' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' description: '' patch: operationId: tasks_partial_update parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTaskSerializerV2' application/xml: schema: $ref: '#/components/schemas/PatchedTaskSerializerV2' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' description: '' /tasks/{id}/accept/: post: operationId: tasks_accept_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/{id}/account_change/: post: operationId: tasks_account_change_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAccountChange' application/xml: schema: $ref: '#/components/schemas/TaskAccountChange' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAccountChange' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAccountChange' description: '' /tasks/{id}/activate/: post: operationId: tasks_activate_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/{id}/assign/: post: operationId: tasks_assign_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAssign' application/xml: schema: $ref: '#/components/schemas/TaskAssign' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAssign' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAssign' description: '' /tasks/{id}/cancel/: post: operationId: tasks_cancel_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/{id}/complete/: post: operationId: tasks_complete_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/{id}/documents/: get: operationId: tasks_documents_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' description: '' /tasks/{id}/events/: get: operationId: tasks_events_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' description: '' /tasks/{id}/fail/: post: operationId: tasks_fail_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/{id}/reject/: post: operationId: tasks_reject_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/{id}/signatures/: get: operationId: tasks_signatures_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' description: '' /tasks/{id}/transit/: post: operationId: tasks_transit_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/{id}/unaccept/: post: operationId: tasks_unaccept_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/{id}/unassign/: post: operationId: tasks_unassign_create parameters: - in: query name: format schema: type: string enum: - json - xml - in: path name: id schema: type: string format: uuid description: A UUID string identifying this task. required: true - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskAction' application/xml: schema: $ref: '#/components/schemas/TaskAction' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskAction' description: '' /tasks/reorder/: post: operationId: tasks_reorder_create parameters: - in: query name: format schema: type: string enum: - json - xml - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskListReorderRequest' application/xml: schema: $ref: '#/components/schemas/TaskListReorderRequest' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskListReorderRequest' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskListReorderRequest' description: '' /tasks/reposition/: post: operationId: tasks_reposition_create parameters: - in: query name: format schema: type: string enum: - json - xml - 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 tags: - tasks requestBody: content: application/json: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml: schema: $ref: '#/components/schemas/TaskSerializerV2' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/TaskSerializerV2' description: '' /time_location_features/: get: operationId: time_location_features_list parameters: - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: state required: false in: query description: state schema: type: string enum: - unknown - stopped - moving - name: time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: user required: false in: query description: user schema: type: string tags: - time_location_features security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTimeLocationFeatureList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTimeLocationFeatureList' description: '' post: operationId: time_location_features_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - time_location_features requestBody: content: application/json: schema: $ref: '#/components/schemas/TimeLocationFeature' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TimeLocationFeature' multipart/form-data: schema: $ref: '#/components/schemas/TimeLocationFeature' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocationFeature' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocationFeature' description: '' /time_location_features/{id}/: get: operationId: time_location_features_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/TimeLocationFeature' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocationFeature' description: '' put: operationId: time_location_features_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TimeLocationFeature' multipart/form-data: schema: $ref: '#/components/schemas/TimeLocationFeature' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocationFeature' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocationFeature' description: '' patch: operationId: time_location_features_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTimeLocationFeature' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTimeLocationFeature' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocationFeature' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocationFeature' description: '' delete: operationId: time_location_features_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: state required: false in: query description: state schema: type: string enum: - unknown - stopped - moving - name: time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: user required: false in: query description: user schema: type: string tags: - time_locations security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTimeLocationList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTimeLocationList' description: '' post: operationId: time_locations_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - time_locations requestBody: content: application/json: schema: $ref: '#/components/schemas/TimeLocation' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TimeLocation' multipart/form-data: schema: $ref: '#/components/schemas/TimeLocation' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocation' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocation' description: '' /time_locations/{id}/: get: operationId: time_locations_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/TimeLocation' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/TimeLocation' description: '' /trackers/: get: operationId: trackers_list parameters: - name: account required: false in: query description: account schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - trackers security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTrackerList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedTrackerList' description: '' post: operationId: trackers_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - trackers requestBody: content: application/json: schema: $ref: '#/components/schemas/Tracker' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Tracker' multipart/form-data: schema: $ref: '#/components/schemas/Tracker' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Tracker' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Tracker' description: '' /trackers/{id}/: get: operationId: trackers_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Tracker' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Tracker' description: '' put: operationId: trackers_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Tracker' multipart/form-data: schema: $ref: '#/components/schemas/Tracker' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Tracker' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Tracker' description: '' patch: operationId: trackers_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTracker' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTracker' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Tracker' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Tracker' description: '' /trackers/{id}/public/: get: operationId: trackers_public_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Tracker' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Tracker' description: '' /users/: get: operationId: users_list parameters: - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xml - 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: - users security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedUserList' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' post: operationId: users_create parameters: - in: query name: format schema: type: string enum: - json - xml tags: - users requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthenticatedUserCreate' application/xml: schema: $ref: '#/components/schemas/AuthenticatedUserCreate' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' /users/{id}/: get: operationId: users_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - 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.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' put: operationId: users_update parameters: - in: query name: format schema: type: string enum: - json - xml - 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' application/xml: schema: $ref: '#/components/schemas/AuthenticatedUserUpdate' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' patch: operationId: users_partial_update parameters: - in: query name: format schema: type: string enum: - json - xml - 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' application/xml: schema: $ref: '#/components/schemas/PatchedAuthenticatedUserUpdate' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' delete: operationId: users_destroy parameters: - in: query name: format schema: type: string enum: - json - xml - 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.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' /users/{id}/activate/: post: operationId: users_activate_create parameters: - in: query name: format schema: type: string enum: - json - xml - 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/UserActivation' application/xml: schema: $ref: '#/components/schemas/UserActivation' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' /users/{id}/on_duty/: get: operationId: users_on_duty_retrieve parameters: - in: query name: format schema: type: string enum: - json - xml - 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.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' put: operationId: users_on_duty_update parameters: - in: query name: format schema: type: string enum: - json - xml - 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' application/xml: schema: $ref: '#/components/schemas/OnDuty' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' delete: operationId: users_on_duty_destroy parameters: - in: query name: format schema: type: string enum: - json - xml - 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.4.13: schema: $ref: '#/components/schemas/User' application/xml; version=2.4.13: schema: $ref: '#/components/schemas/User' description: '' /users_on_duty_log/: get: operationId: users_on_duty_log_list parameters: - name: account required: false in: query description: account schema: type: string - name: account_role required: false in: query description: account_role schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: mode required: false in: query description: mode schema: type: string enum: - online - 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 - name: status required: false in: query description: status schema: type: string enum: - on_duty - off_duty - name: timestamp__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: timestamp__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: timestamp__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: user required: false in: query description: user schema: type: string tags: - users_on_duty_log security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedWorkingStateList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedWorkingStateList' description: '' post: operationId: users_on_duty_log_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - users_on_duty_log requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkingState' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/WorkingState' multipart/form-data: schema: $ref: '#/components/schemas/WorkingState' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/WorkingState' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/WorkingState' description: '' /users_on_duty_log/{id}/: get: operationId: users_on_duty_log_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this user. required: true tags: - users_on_duty_log security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/WorkingState' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/WorkingState' description: '' /webhooks/: get: operationId: webhooks_list parameters: - name: account required: false in: query description: account schema: type: string - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - name: document_events required: false in: query description: document_events schema: type: string - in: query name: format schema: type: string enum: - json - xlsx - 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: review_events required: false in: query description: review_events schema: type: string - name: search required: false in: query description: A search term. schema: type: string - name: signature_events required: false in: query description: signature_events schema: type: string - name: state required: false in: query description: state schema: type: string enum: - inactive - active - disabled - name: task_events required: false in: query description: task_events schema: type: string - name: version required: false in: query description: version schema: type: string tags: - webhooks security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedWebhookList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedWebhookList' description: '' post: operationId: webhooks_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - webhooks requestBody: content: application/json: schema: $ref: '#/components/schemas/Webhook' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Webhook' multipart/form-data: schema: $ref: '#/components/schemas/Webhook' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' description: '' /webhooks/{id}/: get: operationId: webhooks_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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.4.13: schema: $ref: '#/components/schemas/Webhook' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' description: '' put: operationId: webhooks_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Webhook' multipart/form-data: schema: $ref: '#/components/schemas/Webhook' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' description: '' patch: operationId: webhooks_partial_update parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedWebhook' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWebhook' security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' description: '' delete: operationId: webhooks_destroy parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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 parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Webhook' multipart/form-data: schema: $ref: '#/components/schemas/Webhook' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' description: '' /webhooks/{id}/inactive/: post: operationId: webhooks_inactive_create parameters: - in: query name: format schema: type: string enum: - json - xlsx - 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' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Webhook' multipart/form-data: schema: $ref: '#/components/schemas/Webhook' required: true security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/Webhook' application/xlsx; version=2.4.13: 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__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: state required: false in: query description: state schema: type: string enum: - unknown - stopped - moving - name: time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+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.4.13: schema: $ref: '#/components/schemas/PaginatedWorkerFeatureList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedWorkerFeatureList' description: '' /worker_features/{user_id}/: get: operationId: worker_features_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: user_id schema: type: string format: uuid required: true tags: - worker_features security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/WorkerFeature' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/WorkerFeature' description: '' /worker_tracks/: get: operationId: worker_tracks_list parameters: - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: end_time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: end_time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: end_time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: end_time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: end_time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: end_time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: end_time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: end_time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: end_time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: end_time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - in: query name: format schema: type: string enum: - json - xlsx - name: start_time__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: start_time__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: start_time__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: start_time__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: start_time__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: start_time__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: start_time__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: start_time__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: start_time__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: start_time__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: updated_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: updated_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime tags: - worker_tracks security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: type: array items: $ref: '#/components/schemas/WorkerTrack' application/xlsx; version=2.4.13: schema: type: array items: $ref: '#/components/schemas/WorkerTrack' description: '' /working_state/: get: operationId: working_state_list parameters: - name: account required: false in: query description: account schema: type: string - name: account_role required: false in: query description: account_role schema: type: string - name: created_at__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: created_at__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: created_at__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: cursor required: false in: query description: The pagination cursor value. schema: type: integer - in: query name: format schema: type: string enum: - json - xlsx - name: mode required: false in: query description: mode schema: type: string enum: - online - 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 - name: status required: false in: query description: status schema: type: string enum: - on_duty - off_duty - name: timestamp__date required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: timestamp__date_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: date - name: timestamp__gt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__gt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__gte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__gte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__lt required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__lt_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__lte required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: timestamp__lte_or_isnull required: false in: query example: '2022-11-04T11:19:24+00:00' schema: type: string format: datetime - name: user required: false in: query description: user schema: type: string tags: - working_state security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedWorkingStateList' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/PaginatedWorkingStateList' description: '' post: operationId: working_state_create parameters: - in: query name: format schema: type: string enum: - json - xlsx tags: - working_state requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkingState' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/WorkingState' multipart/form-data: schema: $ref: '#/components/schemas/WorkingState' required: true security: - tokenAuth: [] responses: '201': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/WorkingState' application/xlsx; version=2.4.13: schema: $ref: '#/components/schemas/WorkingState' description: '' /working_state/{id}/: get: operationId: working_state_retrieve parameters: - in: query name: format schema: type: string enum: - json - xlsx - in: path name: id schema: type: string format: uuid description: A UUID string identifying this user. required: true tags: - working_state security: - tokenAuth: [] responses: '200': content: application/json; version=2.4.13: schema: $ref: '#/components/schemas/WorkingState' application/xlsx; version=2.4.13: 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/Type21dEnum' - $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 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 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 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 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 readOnly: true 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. feature_document_signing: type: boolean description: Allow choosing documents to sign. feature_tracker_reviews_allowed: type: boolean 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 dashboard_worker_limit: type: integer readOnly: true managers: type: string format: uri readOnly: true workers: type: string format: uri readOnly: true stripe_customer_id: type: string readOnly: true stripe_payment_method_id: type: string readOnly: 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_change_task_account - feature_geocoding_country_code - id - managers - name - owner - slug - state - stripe_customer_id - stripe_payment_method_id - url - workers AccountBillingMethodEnum: enum: - braintree - free - invoice - stripe - trial type: string 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/AccountRoleStateEnum' readOnly: true email: type: string format: email readOnly: true display_name: type: string nullable: true maxLength: 100 phone: type: string maxLength: 128 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_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})?$ 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_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 last_time_location: type: string format: uri readOnly: true activated_at: type: string format: date-time readOnly: true deleted_at: type: string format: date-time readOnly: 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 required: - token AccountRoleStateEnum: enum: - inactive - active - deleted type: string AccountRoleToken: type: object properties: token: type: string format: uuid readOnly: true required: - token AccountStateEnum: enum: - active - deactive - trial_expired - payment_overdue type: string 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 AccountStripePaymentMethodGet: type: object properties: payment_method_id: type: string maxLength: 100 required: - 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 AccountStripePaymentMethods: type: object properties: default_payment_method_id: type: string readOnly: true maxLength: 100 required: - default_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 AccountStripeSetupIntentGet: type: object properties: setup_intent_id: type: string maxLength: 100 required: - setup_intent_id AccountStripeSetupIntentsGet: type: object properties: payment_method_id: type: string nullable: true maxLength: 100 AccountUser: type: object properties: id: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true first_name: type: string readOnly: true last_name: type: string readOnly: true display_name: type: string readOnly: true email: type: string format: email phone: type: string readOnly: true is_on_duty: type: boolean readOnly: true required: - display_name - email - first_name - id - is_on_duty - last_name - phone - url ActionEnum: enum: - update - reassign - assign - accept - unaccept - reject - unassign - transit - activate - complete - fail - cancel - assignee_near - assignee_away type: string 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 AssigneeProximityEnum: enum: - away - near type: string AuthToken: type: object properties: username: type: string writeOnly: true password: type: string writeOnly: true token: type: string readOnly: true required: - password - token - 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 BlankEnum: enum: - '' BraintreeCustomer: type: object properties: id: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true braintree_id: type: string nullable: true maxLength: 36 account: type: string format: uri first_name: type: string maxLength: 255 last_name: type: string maxLength: 255 company: type: string maxLength: 255 email: type: string format: email maxLength: 254 phone: type: string maxLength: 14 website: type: string maxLength: 100 vat: type: string maxLength: 20 payment_method_nonce: type: string nullable: true maxLength: 250 created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - account - created_at - id - updated_at - url BraintreeTransaction: type: object properties: id: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true invoice: type: string format: uri customer: type: string format: uri type: type: string maxLength: 6 status: type: string maxLength: 24 amount: type: string format: decimal pattern: ^-?\d{0,7}(?:\.\d{0,2})?$ currency: type: string maxLength: 3 timestamp: type: string format: date-time readOnly: true response: type: string readOnly: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - amount - created_at - customer - id - invoice - response - timestamp - updated_at - url 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_duration: type: object default: 4 10:55:34.12 distance_units: type: string required: - distance_units - task_duration 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 location: allOf: - $ref: '#/components/schemas/Location' readOnly: true is_client_role: type: boolean default: false billing: type: object additionalProperties: {} readOnly: true required: - account - app - auth - billing - defaults - features - id - legacy_views - location - notifications - permissions - 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 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 completed_at: type: string format: date-time readOnly: true failed_at: type: string format: date-time readOnly: true errors: type: object additionalProperties: {} readOnly: true celery_task_id: type: string readOnly: 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 DashboardScene: type: object properties: orders: type: array items: $ref: '#/components/schemas/Order' tasks: type: array items: $ref: '#/components/schemas/LegacyTask' task_metadatas: type: array items: $ref: '#/components/schemas/TaskMetadata' assigned_task_counts: type: object additionalProperties: {} readOnly: true workers: type: array items: $ref: '#/components/schemas/AccountUser' worker_features: type: array items: $ref: '#/components/schemas/WorkerFeature' updated_at: type: string format: date-time readOnly: true required: - assigned_task_counts - orders - task_metadatas - tasks - updated_at - worker_features - workers DateFormatEnum: enum: - DD.MM.YYYY - YYYY-MM-DD - DD/MM/YYYY - MM/DD/YYYY type: string 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 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 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 thumbnail: type: string format: uri readOnly: true description: type: string created_by: type: string format: uri readOnly: true source: nullable: true oneOf: - $ref: '#/components/schemas/SourceEnum' - $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 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 failed_at: type: string format: date-time readOnly: true received_at: type: string format: date-time readOnly: 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 EventEnum: enum: - create - assign - unassign - reject - accept - unaccept - transit - activate - complete - fail - cancel - assignee_near - assignee_away - updated type: string 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 FeatureAddressAutosuggestProviderEnum: enum: - google - heremaps - regio - janaseta type: string FieldEnum: enum: - state - assignee_proximity type: string 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: 200 view_url: type: string format: uri nullable: true maxLength: 200 pdf_url: type: string format: uri nullable: true maxLength: 200 rules: type: object additionalProperties: {} required: - account - edit_url - id - name - rules - url FormatEnum: enum: - json - xlsx type: string 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 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 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 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 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 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 InvoiceStateEnum: enum: - draft - confirmed - overdue - paid - cancelled type: string LanguageEnum: enum: - af - ar - ar-dz - ast - az - bg - be - bn - br - bs - ca - 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 - 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 - uk - ur - uz - vi - zh-hans - zh-hant type: string LegacyNestedContact: type: object description: |- Support depreciated fields phone and email write to new fields phones[0] and emails[0] properties: name: type: string maxLength: 200 company: type: string maxLength: 200 phone: type: string nullable: true maxLength: 100 email: type: string nullable: true maxLength: 100 phones: type: array items: type: string maxLength: 100 emails: type: array items: type: string maxLength: 100 notes: type: string LegacyTask: 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/LegacyNestedContact' 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 cancelled_at: type: string format: date-time readOnly: 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: type: object additionalProperties: {} forms: type: object additionalProperties: {} readOnly: true 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 LevelEnum: enum: - danger - warning - success type: string 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 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: 200 is_editable: type: boolean description: Editable by manager is_editable_assignee: type: boolean description: Editable by assignee is_required: type: boolean is_persistent: type: boolean description: Metadata, that will be copied to on recurrence. is_searchable: type: boolean show_in_list_view: type: boolean show_in_detail_view: type: boolean show_in_mobile_app: 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 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 - updated_at - url MethodEnum: enum: - app - email - sms type: string ModeEnum: enum: - online - offline type: string 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 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 geocode_failed_at: type: string format: date-time readOnly: true required: - geocode_failed_at - geocoded_at 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 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_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 email_reply_to: type: string format: email maxLength: 254 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 OnDuty: type: object properties: account: type: string format: uri required: - account Order: 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 tasks: type: array items: type: string format: uri auto_assign: type: boolean 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 - tasks - updated_at - url OrderListScene: type: object properties: clients: type: array items: $ref: '#/components/schemas/Client' orders: type: array items: $ref: '#/components/schemas/Order' tasks: type: array items: $ref: '#/components/schemas/LegacyTask' assignees: type: array items: $ref: '#/components/schemas/PublicUser' required: - assignees - clients - orders - tasks 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 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 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 - 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' PaginatedBraintreeCustomerList: type: array items: $ref: '#/components/schemas/BraintreeCustomer' PaginatedBraintreeTransactionList: type: array items: $ref: '#/components/schemas/BraintreeTransaction' 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' PaginatedDashboardSceneList: type: array items: $ref: '#/components/schemas/DashboardScene' 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' 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' PaginatedOrderListSceneList: type: array items: $ref: '#/components/schemas/OrderListScene' PaginatedOrderSerializerV2List: type: array items: $ref: '#/components/schemas/OrderSerializerV2' PaginatedPushNotificationList: type: array items: $ref: '#/components/schemas/PushNotification' PaginatedRecurrenceList: type: array items: $ref: '#/components/schemas/Recurrence' PaginatedRecurrenceListSceneList: type: array items: $ref: '#/components/schemas/RecurrenceListScene' 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' PaginatedSignatureList: type: array items: $ref: '#/components/schemas/Signature' PaginatedStripePaymentList: type: array items: $ref: '#/components/schemas/StripePayment' PaginatedTaskAddressFeatureList: type: array items: $ref: '#/components/schemas/TaskAddressFeature' PaginatedTaskCommandList: type: array items: $ref: '#/components/schemas/TaskCommand' PaginatedTaskEventSerializerV2List: type: array items: $ref: '#/components/schemas/TaskEventSerializerV2' PaginatedTaskEventTrackList: type: array items: $ref: '#/components/schemas/TaskEventTrack' PaginatedTaskExportList: type: array items: $ref: '#/components/schemas/TaskExport' PaginatedTaskFormList: type: array items: $ref: '#/components/schemas/TaskForm' PaginatedTaskListSceneList: type: array items: $ref: '#/components/schemas/TaskListScene' 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: type: array items: $ref: '#/components/schemas/TimeLocationFeature' PaginatedTimeLocationList: type: array items: $ref: '#/components/schemas/TimeLocation' PaginatedTrackerList: type: array items: $ref: '#/components/schemas/Tracker' PaginatedUserList: type: array items: $ref: '#/components/schemas/User' PaginatedWebhookList: type: array items: $ref: '#/components/schemas/Webhook' PaginatedWorkerFeatureList: type: array items: $ref: '#/components/schemas/WorkerFeature' 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: uidb64: type: string token: type: string new_password1: type: string new_password2: type: string required: - new_password1 - new_password2 - token - uidb64 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/Type21dEnum' - $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 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 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 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 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 readOnly: true 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. feature_document_signing: type: boolean description: Allow choosing documents to sign. feature_tracker_reviews_allowed: type: boolean 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 dashboard_worker_limit: type: integer readOnly: true managers: type: string format: uri readOnly: true workers: type: string format: uri readOnly: true stripe_customer_id: type: string readOnly: true stripe_payment_method_id: type: string readOnly: 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/AccountRoleStateEnum' readOnly: true email: type: string format: email readOnly: true display_name: type: string nullable: true maxLength: 100 phone: type: string maxLength: 128 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_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})?$ 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_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 last_time_location: type: string format: uri readOnly: true activated_at: type: string format: date-time readOnly: true deleted_at: type: string format: date-time readOnly: 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' PatchedBraintreeCustomer: type: object properties: id: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true braintree_id: type: string nullable: true maxLength: 36 account: type: string format: uri first_name: type: string maxLength: 255 last_name: type: string maxLength: 255 company: type: string maxLength: 255 email: type: string format: email maxLength: 254 phone: type: string maxLength: 14 website: type: string maxLength: 100 vat: type: string maxLength: 20 payment_method_nonce: type: string nullable: true maxLength: 250 created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true 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 created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true PatchedEmail: 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 failed_at: type: string format: date-time readOnly: true received_at: type: string format: date-time readOnly: true created_at: type: string format: date-time readOnly: true 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 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: 200 view_url: type: string format: uri nullable: true maxLength: 200 pdf_url: type: string format: uri nullable: true maxLength: 200 rules: type: object additionalProperties: {} 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 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 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 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 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: 200 is_editable: type: boolean description: Editable by manager is_editable_assignee: type: boolean description: Editable by assignee is_required: type: boolean is_persistent: type: boolean description: Metadata, that will be copied to on recurrence. is_searchable: type: boolean show_in_list_view: type: boolean show_in_detail_view: type: boolean show_in_mobile_app: 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 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_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 email_reply_to: type: string format: email maxLength: 254 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 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 created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true PatchedPushNotification: 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 failed_at: type: string format: date-time readOnly: true sent_at: type: string format: date-time readOnly: true created_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 order: type: string format: uri assignee: type: string format: uri nullable: true is_active: type: boolean default: true rrule: type: string timezone: $ref: '#/components/schemas/TimezoneEnum' last_recurred_at: type: string format: date-time readOnly: true last_scheduled_at: type: string format: date-time readOnly: true next_scheduled_at: type: string format: date-time readOnly: true tasks_data: type: object additionalProperties: {} 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 description: type: string assignee: type: string format: uri start_time: type: string format: date-time nullable: true start_location: allOf: - $ref: '#/components/schemas/Location' nullable: true end_time: type: string format: date-time nullable: true end_location: allOf: - $ref: '#/components/schemas/Location' nullable: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true PatchedSMS: 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 failed_at: type: string format: date-time readOnly: true received_at: type: string format: date-time readOnly: true created_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 name: type: string maxLength: 50 link: type: string format: uri readOnly: true edit_url: type: string format: uri maxLength: 200 view_url: type: string format: uri maxLength: 200 pdf_url: type: string format: uri maxLength: 200 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 writeOnly: true nullable: true contact_address_external_id: type: string writeOnly: true nullable: true description: type: string 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 cancelled_at: type: string format: date-time readOnly: 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: type: object additionalProperties: {} readOnly: true documents: type: array items: type: string format: uri signatures: type: array items: type: string format: uri metafields: type: object additionalProperties: {} trackers: type: array items: 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_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true PatchedTimeLocationFeature: type: object description: |- A subclass of ModelSerializer that outputs geojson-ready data as features and feature collections properties: model: type: string readOnly: true id: type: string format: uuid readOnly: true source: type: string readOnly: true user: type: string format: uri readOnly: true time: type: string format: date-time 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 location: $ref: '#/components/schemas/Location' 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' 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 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: type: object additionalProperties: {} target: type: string format: uri maxLength: 200 task_events: type: boolean document_events: type: boolean signature_events: type: boolean review_events: type: boolean notification_emails: type: array items: type: string format: email maxLength: 254 failure_count: type: integer readOnly: true disable_message: type: string readOnly: true shared_secret: type: string maxLength: 40 activated_at: type: string format: date-time readOnly: true disabled_at: type: string format: date-time readOnly: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true PublicUser: type: object properties: id: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true display_name: type: string readOnly: true email: type: string format: email required: - display_name - email - id - url 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 failed_at: type: string format: date-time readOnly: true sent_at: type: string format: date-time readOnly: 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 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 required: - display_name - email - id - intercom_hash - url RecipientEnum: enum: - account - assignee - orderer - contact - client type: string Recurrence: type: object properties: id: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true account: type: string format: uri order: type: string format: uri assignee: type: string format: uri nullable: true is_active: type: boolean default: true rrule: type: string timezone: $ref: '#/components/schemas/TimezoneEnum' last_recurred_at: type: string format: date-time readOnly: true last_scheduled_at: type: string format: date-time readOnly: true next_scheduled_at: type: string format: date-time readOnly: true tasks_data: type: object additionalProperties: {} 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 - order - rrule - updated_at - url RecurrenceListScene: type: object properties: clients: type: array items: $ref: '#/components/schemas/Client' orders: type: array items: $ref: '#/components/schemas/Order' tasks: type: array items: $ref: '#/components/schemas/Task' assignees: type: array items: $ref: '#/components/schemas/ReadableUser' recurrences: type: array items: $ref: '#/components/schemas/Recurrence' required: - assignees - clients - orders - recurrences - tasks Registration: type: object properties: account: $ref: '#/components/schemas/RegistrationAccount' user: $ref: '#/components/schemas/RegistrationUser' token: type: string readOnly: true required: - account - 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/Type21dEnum' - $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 email: type: string format: email 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 Review: type: object properties: id: type: string format: uuid 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: - 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 description: type: string assignee: type: string format: uri start_time: type: string format: date-time nullable: true start_location: allOf: - $ref: '#/components/schemas/Location' nullable: true end_time: type: string format: date-time nullable: true end_location: allOf: - $ref: '#/components/schemas/Location' nullable: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - account - code - created_at - id - updated_at - url 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/RouteOptimizationSerializerV2StateEnum' 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_location: allOf: - $ref: '#/components/schemas/Location' nullable: true end_location: allOf: - $ref: '#/components/schemas/Location' nullable: true unassign_not_optimal: type: boolean total_distance: type: integer readOnly: true total_duration: type: object readOnly: 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 scheduled_at: type: string format: date-time readOnly: true started_at: type: string format: date-time readOnly: true ready_at: type: string format: date-time readOnly: true completed_at: type: string format: date-time readOnly: true failed_at: type: string format: date-time readOnly: 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 RouteOptimizationSerializerV2StateEnum: enum: - pending - started - ready - completed - over_quota - failed type: string 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: type: object additionalProperties: {} nullable: true readOnly: true created_by: type: string format: uri readOnly: true source: nullable: true oneOf: - $ref: '#/components/schemas/SourceEnum' - $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 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 failed_at: type: string format: date-time readOnly: true received_at: type: string format: date-time readOnly: 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 Signature: 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 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 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 created_by: type: string format: uri readOnly: true source: nullable: true oneOf: - $ref: '#/components/schemas/SourceEnum' - $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 SourceEnum: enum: - web - mobile - integration type: string StatusEnum: enum: - on_duty - off_duty type: string 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 StripeStateEnum: enum: - requires_payment_method - requires_confirmation - requires_capture - requires_action - processing - succeeded - 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 cancelled_at: type: string format: date-time readOnly: 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: type: object additionalProperties: {} forms: type: object additionalProperties: {} readOnly: true 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 TaskAddressFeature: type: object description: |- A subclass of ModelSerializer that outputs geojson-ready data as features and feature collections properties: model: type: string readOnly: true id: type: string format: uuid readOnly: true task: type: string format: uri readOnly: true formatted_address: type: string readOnly: true category: $ref: '#/components/schemas/TaskCategoryEnum' state: $ref: '#/components/schemas/TaskStateEnum' geometry: $ref: '#/components/schemas/Location' required: - formatted_address - geometry - id - model - task 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 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 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' 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 writeOnly: true nullable: true contact_address_external_id: type: string nullable: true readOnly: true description: type: string 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 cancelled_at: type: string format: date-time readOnly: 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: type: object additionalProperties: {} readOnly: true documents: type: array items: type: string format: uri signatures: type: array items: type: string format: uri metafields: type: object additionalProperties: {} trackers: type: array items: 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_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - account - actions - assignee_proximity - cancelled_at - completed_at - contact_address_external_id - counts - created_at - forms - issues - orderer_name - state - trackers - updated_at - url TaskEventTrack: type: object description: |- A subclass of ModelSerializer that outputs geojson-ready data as features and feature collections properties: id: type: string format: uuid readOnly: true 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: 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: uuid readOnly: 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 track: allOf: - $ref: '#/components/schemas/Location' readOnly: true required: - created_at - event - from_state - id - model - task - task_event - to_state - track - updated_at - url - user TaskEventTransitionStatesEnum: enum: - unassigned - assigned - accepted - transit - active - completed - failed - cancelled - away - near type: string TaskExpiryStateEnum: enum: - cancelled - completed type: string 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: '' 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__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: '' 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__geocoded_at: type: string format: date-time default: null address__geocode_failed_at: type: string format: date-time default: null route__code: type: string default: '' route__description: type: string default: '' 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 required: - account__name - address__location - assignee__display_name - contact_address_external_id - created_at - created_by__display_name - 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 name: type: string maxLength: 50 link: type: string format: uri readOnly: true edit_url: type: string format: uri maxLength: 200 view_url: type: string format: uri maxLength: 200 pdf_url: type: string format: uri maxLength: 200 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 - id - link - name - 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 TaskListScene: type: object properties: clients: type: array items: $ref: '#/components/schemas/Client' orders: type: array items: $ref: '#/components/schemas/Order' tasks: type: array items: $ref: '#/components/schemas/LegacyTask' task_metadatas: type: array items: $ref: '#/components/schemas/TaskMetadata' task_events_with_notes: type: array items: $ref: '#/components/schemas/TaskEvent' users: type: array items: $ref: '#/components/schemas/PublicUser' updated_at: type: string format: date-time readOnly: true required: - clients - orders - task_events_with_notes - task_metadatas - tasks - updated_at - users 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 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 writeOnly: true nullable: true contact_address_external_id: type: string writeOnly: true nullable: true description: type: string 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 cancelled_at: type: string format: date-time readOnly: 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: type: object additionalProperties: {} readOnly: true documents: type: array items: type: string format: uri signatures: type: array items: type: string format: uri metafields: type: object additionalProperties: {} trackers: type: array items: 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_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - account - actions - assignee_proximity - cancelled_at - completed_at - counts - created_at - forms - issues - orderer_name - state - trackers - updated_at - url TaskStateEnum: enum: - unassigned - assigned - accepted - transit - active - completed - failed - cancelled type: string 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 completed_at: type: string format: date-time readOnly: true failed_at: type: string format: date-time readOnly: true errors: type: object additionalProperties: {} 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 TasksStatesCount: type: object properties: 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 - 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 TimeLocation: type: object properties: id: type: string format: uuid readOnly: true url: type: string format: uri readOnly: true source: type: string readOnly: true user: type: string format: uri readOnly: true time: type: string format: date-time location: $ref: '#/components/schemas/Location' 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 description: |- A subclass of ModelSerializer that outputs geojson-ready data as features and feature collections properties: model: type: string readOnly: true id: type: string format: uuid readOnly: true source: type: string readOnly: true user: type: string format: uri readOnly: true time: type: string format: date-time 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 location: $ref: '#/components/schemas/Location' required: - created_at - id - location - model - source - time - updated_at - user TimeLocationStateEnum: enum: - unknown - stopped - moving type: string TimezoneEnum: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - 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/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - 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/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Costa_Rica - 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/Fort_Nelson - America/Fortaleza - America/Glace_Bay - 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/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - 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_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - 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/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - 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/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - 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/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - 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/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - 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/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - 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/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string 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' 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 created_by: type: string format: uri readOnly: true required: - account - created_by - id - reviewed_at - tasks - tracking_page_url - url Type21dEnum: enum: - service - delivery type: string User: oneOf: - $ref: '#/components/schemas/OnDuty' - $ref: '#/components/schemas/AuthenticatedUserCreate' - $ref: '#/components/schemas/AuthenticatedUserUpdate' - $ref: '#/components/schemas/ReadableUser' UserActivation: type: object properties: token: type: string format: uuid writeOnly: true password: type: string writeOnly: true required: - token ValueTypeEnum: enum: - string - integer - decimal - choice type: string VehicleProfileEnum: enum: - bike - bus - car - foot - scooter - small_truck - truck type: string VersionEnum: enum: - 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 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: type: object additionalProperties: {} target: type: string format: uri maxLength: 200 task_events: type: boolean document_events: type: boolean signature_events: type: boolean review_events: type: boolean notification_emails: type: array items: type: string format: email maxLength: 254 failure_count: type: integer readOnly: true disable_message: type: string readOnly: true shared_secret: type: string maxLength: 40 activated_at: type: string format: date-time readOnly: true disabled_at: type: string format: date-time readOnly: 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 - disable_message - disabled_at - failure_count - id - name - state - target - updated_at - url WebhookStateEnum: enum: - inactive - active - disabled type: string WorkerFeature: type: object description: |- A subclass of ModelSerializer that outputs geojson-ready data as features and feature collections properties: model: type: string readOnly: true id: type: string format: uuid url: type: string format: uri readOnly: true time_location: type: string format: uri readOnly: true source: type: string readOnly: true user: type: string format: uri readOnly: true user_name: type: string readOnly: true time: type: string format: date-time state: $ref: '#/components/schemas/TimeLocationStateEnum' 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 location: $ref: '#/components/schemas/Location' required: - created_at - id - location - model - source - time - time_location - updated_at - url - user - user_name WorkerTrack: type: object description: |- A subclass of ModelSerializer that outputs geojson-ready data as features and feature collections properties: id: type: string readOnly: true track: $ref: '#/components/schemas/Location' user: type: string format: uuid start_time: type: string format: date-time end_time: type: string format: date-time required: - end_time - id - start_time - track - user 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"