GSMTasks Project API
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
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.3",
"info": {
"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.",
"title": "GSMTasks Project API",
"version": "2.4.13",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_gsmtasks.com_wp-content_uploads_2021_05_cropped-favicon-1-180x180.png"
},
"x-origin": [
{
"format": "openapi",
"url": "https://raw.githubusercontent.com/oeklo/gsmtasks-schema/v2.4.13/GSMTasks.yaml",
"version": "3.0"
}
],
"x-providerName": "gsmtasks.com"
},
"paths": {
"/account_roles/": {
"get": {
"operationId": "account_roles_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "activated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "deleted_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "display_name",
"in": "query",
"name": "display_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"example": true,
"in": "query",
"name": "is_active",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "is_integration",
"in": "query",
"name": "is_integration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_manager",
"in": "query",
"name": "is_manager",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_worker",
"in": "query",
"name": "is_worker",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"inactive",
"active",
"deleted"
],
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
},
"post": {
"operationId": "account_roles_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountRole"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountRole"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
}
},
"/account_roles/{id}/": {
"delete": {
"operationId": "account_roles_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
},
"get": {
"operationId": "account_roles_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
},
"patch": {
"operationId": "account_roles_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedAccountRole"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PatchedAccountRole"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
},
"put": {
"operationId": "account_roles_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountRole"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountRole"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
}
},
"/account_roles/{id}/activate/": {
"post": {
"operationId": "account_roles_activate_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountRoleActivation"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountRoleActivation"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
}
},
"/account_roles/{id}/notify/": {
"post": {
"operationId": "account_roles_notify_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
}
},
"/account_roles/{id}/token/": {
"get": {
"operationId": "account_roles_token_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"account_roles"
]
}
},
"/accounts/": {
"get": {
"operationId": "accounts_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/": {
"get": {
"operationId": "accounts_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
},
"patch": {
"operationId": "accounts_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
},
"put": {
"operationId": "accounts_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/braintree_customer/": {
"get": {
"operationId": "accounts_braintree_customer_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/change_owner/": {
"post": {
"operationId": "accounts_change_owner_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/managers/": {
"delete": {
"operationId": "accounts_managers_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
},
"get": {
"operationId": "accounts_managers_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
},
"post": {
"operationId": "accounts_managers_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_attach_payment_method/": {
"put": {
"description": "Action to (re)set the account stripe customer and payment method to new values.\nBy default the attached method will also be set as default.\nIf this is not desired, you can send\n\n 'set_default': False",
"operationId": "accounts_stripe_attach_payment_method_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_create_setup_intent/": {
"post": {
"description": "Action to start a new setup intent.",
"operationId": "accounts_stripe_create_setup_intent_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
},
"put": {
"description": "Action to start a new setup intent.",
"operationId": "accounts_stripe_create_setup_intent_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_detach_payment_method/": {
"put": {
"description": "Detached payment method from the customer.\nThe payment method itself will remain somewhere in stripe, but as its no longer linked to the customer,\nit might as well be deleted for us",
"operationId": "accounts_stripe_detach_payment_method_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_get_payment_method/": {
"get": {
"description": "Fetch a single payment method from stripe.\nThis will also return non-attached payment methods (from setup intents for example)",
"operationId": "accounts_stripe_get_payment_method_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_get_setup_attempt/": {
"get": {
"description": "Fetch a single setup intent",
"operationId": "accounts_stripe_get_setup_attempt_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_get_setup_intent/": {
"get": {
"description": "Fetch a single setup intent",
"operationId": "accounts_stripe_get_setup_intent_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_payment_methods/": {
"get": {
"description": "Fetch all customer payment methods.\nThis includes all attached payment methods, default method_id",
"operationId": "accounts_stripe_payment_methods_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_set_default_payment_method/": {
"put": {
"description": "Action to set a payment method to default.",
"operationId": "accounts_stripe_set_default_payment_method_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/stripe_setup_intents/": {
"get": {
"description": "Fetch existing setup intents",
"operationId": "accounts_stripe_setup_intents_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/accounts/{id}/workers/": {
"delete": {
"operationId": "accounts_workers_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
},
"get": {
"operationId": "accounts_workers_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
},
"post": {
"operationId": "accounts_workers_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this account.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"accounts"
]
}
},
"/addons/": {
"get": {
"operationId": "addons_list",
"parameters": [
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"addons"
]
}
},
"/addons/{id}/": {
"get": {
"operationId": "addons_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this addon.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"addons"
]
}
},
"/authenticate/": {
"post": {
"operationId": "authenticate_create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthToken"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AuthToken"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/AuthToken"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthToken"
}
}
},
"description": ""
}
},
"tags": [
"authenticate"
]
}
},
"/billing/customers/": {
"get": {
"operationId": "billing_customers_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
},
"post": {
"operationId": "billing_customers_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/customers/{id}/": {
"get": {
"operationId": "billing_customers_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this braintree customer.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
},
"patch": {
"operationId": "billing_customers_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this braintree customer.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
},
"put": {
"operationId": "billing_customers_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this braintree customer.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/customers/{id}/client_token/": {
"get": {
"operationId": "billing_customers_client_token_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this braintree customer.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/invoices/": {
"get": {
"operationId": "billing_invoices_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "billing_method",
"in": "query",
"name": "billing_method",
"required": false,
"schema": {
"enum": [
"braintree",
"invoice",
"stripe"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "confirmed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "created_at",
"in": "query",
"name": "created_at",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"draft",
"confirmed",
"overdue",
"paid",
"cancelled"
],
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/invoices/{id}/": {
"get": {
"operationId": "billing_invoices_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this invoice.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
},
"patch": {
"operationId": "billing_invoices_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this invoice.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
},
"put": {
"operationId": "billing_invoices_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this invoice.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/invoices/{id}/mark_as_paid/": {
"post": {
"operationId": "billing_invoices_mark_as_paid_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this invoice.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/stripe_payments/": {
"get": {
"operationId": "billing_stripe_payments_list",
"parameters": [
{
"description": "billable_account",
"in": "query",
"name": "billable_account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "invoice",
"in": "query",
"name": "invoice",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"draft",
"failed",
"saved",
"settled",
"rejected",
"retried",
"cancelled"
],
"type": "string"
}
},
{
"description": "stripe_state",
"in": "query",
"name": "stripe_state",
"required": false,
"schema": {
"enum": [
null,
"requires_payment_method",
"requires_confirmation",
"requires_capture",
"requires_action",
"processing",
"succeeded",
"canceled"
],
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/stripe_payments/{id}/": {
"get": {
"operationId": "billing_stripe_payments_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this stripe payment.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/transactions/": {
"get": {
"operationId": "billing_transactions_list",
"parameters": [
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "customer",
"in": "query",
"name": "customer",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "invoice__account",
"in": "query",
"name": "invoice__account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"draft",
"failed",
"saved",
"settled",
"rejected",
"voided",
"refunded",
"retried",
"cancelled",
"imported"
],
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/billing/transactions/{id}/": {
"get": {
"operationId": "billing_transactions_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this braintree transaction.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"billing"
]
}
},
"/client_roles/": {
"get": {
"operationId": "client_roles_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "client",
"in": "query",
"name": "client",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "is_active",
"in": "query",
"name": "is_active",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_manager",
"in": "query",
"name": "is_manager",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"client_roles"
]
},
"post": {
"operationId": "client_roles_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"client_roles"
]
}
},
"/client_roles/{id}/": {
"get": {
"operationId": "client_roles_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this client role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"client_roles"
]
},
"patch": {
"operationId": "client_roles_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this client role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"client_roles"
]
},
"put": {
"operationId": "client_roles_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this client role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"client_roles"
]
}
},
"/client_roles/{id}/notify/": {
"post": {
"operationId": "client_roles_notify_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this client role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"client_roles"
]
}
},
"/clients/": {
"get": {
"operationId": "clients_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "slug",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"clients"
]
},
"post": {
"operationId": "clients_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"clients"
]
}
},
"/clients/{id}/": {
"get": {
"operationId": "clients_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this client.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"clients"
]
},
"patch": {
"operationId": "clients_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this client.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"clients"
]
},
"put": {
"operationId": "clients_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this client.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"clients"
]
}
},
"/configurations/": {
"get": {
"operationId": "configurations_list",
"parameters": [
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"configurations"
]
}
},
"/contact_address_exports/": {
"get": {
"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.\n\nWhen exporting to **excel**, the column names may be changed based on pre-defined field names and width mapping.\n\nAvailable since version 2.2.1",
"operationId": "contact_address_exports_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number",
"in": "query",
"name": "address__apartment_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city",
"in": "query",
"name": "address__city",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country",
"in": "query",
"name": "address__country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code",
"in": "query",
"name": "address__country_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address",
"in": "query",
"name": "address__formatted_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code",
"in": "query",
"name": "address__postal_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state",
"in": "query",
"name": "address__state",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street",
"in": "query",
"name": "address__street",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company",
"in": "query",
"name": "contact__company",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__emails__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__emails__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__emails__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__emails__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name",
"in": "query",
"name": "contact__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes",
"in": "query",
"name": "contact__notes",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__phones__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"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": {
"summary": "Returns fields name, external_id, created_at and address__raw_address in the same order",
"value": "name,external_id,created_at,address__raw_address"
}
},
"in": "query",
"name": "fields",
"schema": {
"type": "string"
}
},
{
"description": "Selects response method. xlsx returns Excel file",
"in": "query",
"name": "format",
"schema": {
"default": "json",
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "is_orderer",
"in": "query",
"name": "is_orderer",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_receiver",
"in": "query",
"name": "is_receiver",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "A page number within the paginated result set.",
"in": "query",
"name": "page",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "source",
"in": "query",
"name": "source",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sourcecontact__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sourcecontact__name__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sourcecontact__name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sourcecontact__name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sourcecontact__name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_address_exports"
]
}
},
"/contact_address_import/": {
"get": {
"operationId": "contact_address_import_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"pending",
"started",
"completed",
"failed"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_address_import"
]
},
"post": {
"operationId": "contact_address_import_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_address_import"
]
}
},
"/contact_address_import/{id}/": {
"get": {
"operationId": "contact_address_import_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this contact address background import.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_address_import"
]
}
},
"/contact_addresses/": {
"get": {
"operationId": "contact_addresses_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number",
"in": "query",
"name": "address__apartment_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__apartment_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city",
"in": "query",
"name": "address__city",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__city__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country",
"in": "query",
"name": "address__country",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code",
"in": "query",
"name": "address__country_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__country_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address",
"in": "query",
"name": "address__formatted_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__formatted_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code",
"in": "query",
"name": "address__postal_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__postal_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state",
"in": "query",
"name": "address__state",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__state__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street",
"in": "query",
"name": "address__street",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "address__street__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "client",
"in": "query",
"name": "client",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company",
"in": "query",
"name": "contact__company",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__company__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__emails__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__emails__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__emails__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__emails__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__emails__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__emails__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "contact__emails__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__emails__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__emails__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name",
"in": "query",
"name": "contact__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__name__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes",
"in": "query",
"name": "contact__notes",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__notes__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__phones__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__phones__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__phones__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__phones__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "contact__phones__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "contact__phones__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "is_orderer",
"in": "query",
"name": "is_orderer",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_receiver",
"in": "query",
"name": "is_receiver",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "source",
"in": "query",
"name": "source",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "source__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "source__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "source__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "source__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "source__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_addresses"
]
},
"post": {
"operationId": "contact_addresses_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_addresses"
]
}
},
"/contact_addresses/{id}/": {
"get": {
"operationId": "contact_addresses_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this contact address.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_addresses"
]
},
"patch": {
"operationId": "contact_addresses_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this contact address.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_addresses"
]
},
"put": {
"operationId": "contact_addresses_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this contact address.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"contact_addresses"
]
}
},
"/devices/": {
"get": {
"operationId": "devices_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "user__account_roles__account",
"in": "query",
"name": "user__account_roles__account",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"devices"
]
},
"post": {
"operationId": "devices_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"devices"
]
}
},
"/devices/{id}/": {
"get": {
"operationId": "devices_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this device.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"devices"
]
}
},
"/docs/schema/": {
"get": {
"description": "OpenApi3 schema for this API. Format can be selected via content negotiation.\n\n- YAML: application/vnd.oai.openapi\n- JSON: application/vnd.oai.openapi+json",
"operationId": "docs_schema_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"yaml"
],
"type": "string"
}
},
{
"in": "query",
"name": "lang",
"schema": {
"enum": [
"de",
"en",
"es",
"et",
"fi",
"fr",
"it",
"lt",
"lv",
"pl",
"ru",
"sv"
],
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"additionalProperties": {},
"type": "object"
}
},
"application/vnd.oai.openapi+json; version=2.4.13": {
"schema": {
"additionalProperties": {},
"type": "object"
}
},
"application/vnd.oai.openapi; version=2.4.13": {
"schema": {
"additionalProperties": {},
"type": "object"
}
},
"application/yaml; version=2.4.13": {
"schema": {
"additionalProperties": {},
"type": "object"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
},
{}
],
"tags": [
"docs"
]
}
},
"/documents/": {
"get": {
"operationId": "documents_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "filename",
"in": "query",
"name": "filename",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "mimetype",
"in": "query",
"name": "mimetype",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order",
"in": "query",
"name": "order",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "source",
"in": "query",
"name": "source",
"required": false,
"schema": {
"enum": [
"web",
"mobile",
"integration"
],
"type": "string"
}
},
{
"description": "task",
"in": "query",
"name": "task",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"documents"
]
},
"post": {
"operationId": "documents_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"documents"
]
}
},
"/documents/batch_delete/": {
"post": {
"description": "Available from version 2.4.2",
"operationId": "documents_batch_delete_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"documents"
]
}
},
"/documents/{id}/": {
"delete": {
"operationId": "documents_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this document.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"documents"
]
},
"get": {
"operationId": "documents_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this document.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"documents"
]
}
},
"/emails/": {
"get": {
"operationId": "emails_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "external_id",
"in": "query",
"name": "external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__icontains",
"in": "query",
"name": "external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "from_email",
"in": "query",
"name": "from_email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "from_email__icontains",
"in": "query",
"name": "from_email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "message",
"in": "query",
"name": "message",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "message__icontains",
"in": "query",
"name": "message__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "reply_to_email",
"in": "query",
"name": "reply_to_email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reply_to_email__icontains",
"in": "query",
"name": "reply_to_email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"queued",
"over_quota",
"sent",
"failed",
"received"
],
"type": "string"
}
},
{
"description": "state__in",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "subject",
"in": "query",
"name": "subject",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "subject__icontains",
"in": "query",
"name": "subject__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"emails"
]
},
"post": {
"operationId": "emails_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"emails"
]
}
},
"/emails/{id}/": {
"delete": {
"operationId": "emails_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this email.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"emails"
]
},
"get": {
"operationId": "emails_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this email.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"emails"
]
},
"patch": {
"operationId": "emails_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this email.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"emails"
]
},
"put": {
"operationId": "emails_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this email.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"emails"
]
}
},
"/emails/{id}/resend/": {
"post": {
"operationId": "emails_resend_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this email.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"emails"
]
}
},
"/exports/": {
"get": {
"operationId": "exports_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"exports"
]
},
"post": {
"operationId": "exports_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"exports"
]
}
},
"/exports/{id}/": {
"delete": {
"operationId": "exports_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this export.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"exports"
]
},
"get": {
"operationId": "exports_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this export.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"exports"
]
},
"patch": {
"operationId": "exports_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this export.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"exports"
]
},
"put": {
"operationId": "exports_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this export.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"exports"
]
}
},
"/file_uploads/": {
"get": {
"operationId": "file_uploads_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "filename",
"in": "query",
"name": "filename",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "source",
"in": "query",
"name": "source",
"required": false,
"schema": {
"enum": [
"web",
"mobile",
"integration"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"file_uploads"
]
},
"post": {
"operationId": "file_uploads_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"file_uploads"
]
}
},
"/file_uploads/{id}/": {
"get": {
"operationId": "file_uploads_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this file upload.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"file_uploads"
]
}
},
"/formrules/": {
"get": {
"operationId": "formrules_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"formrules"
]
},
"post": {
"operationId": "formrules_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"formrules"
]
}
},
"/formrules/{id}/": {
"delete": {
"operationId": "formrules_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this form rule.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"formrules"
]
},
"get": {
"operationId": "formrules_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this form rule.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"formrules"
]
},
"patch": {
"operationId": "formrules_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this form rule.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"formrules"
]
},
"put": {
"operationId": "formrules_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this form rule.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"formrules"
]
}
},
"/integrations/": {
"post": {
"operationId": "integrations_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"integrations"
]
}
},
"/metafields/": {
"get": {
"operationId": "metafields_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "is_editable",
"in": "query",
"name": "is_editable",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_editable_assignee",
"in": "query",
"name": "is_editable_assignee",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_persistent",
"in": "query",
"name": "is_persistent",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_required",
"in": "query",
"name": "is_required",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_searchable",
"in": "query",
"name": "is_searchable",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "key",
"in": "query",
"name": "key",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "label",
"in": "query",
"name": "label",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "namespace",
"in": "query",
"name": "namespace",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "show_in_detail_view",
"in": "query",
"name": "show_in_detail_view",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "show_in_list_view",
"in": "query",
"name": "show_in_list_view",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "show_in_mobile_app",
"in": "query",
"name": "show_in_mobile_app",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "show_in_pod",
"in": "query",
"name": "show_in_pod",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "show_when_task_type_assignment",
"in": "query",
"name": "show_when_task_type_assignment",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "show_when_task_type_drop_off",
"in": "query",
"name": "show_when_task_type_drop_off",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "show_when_task_type_pick_up",
"in": "query",
"name": "show_when_task_type_pick_up",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "value_type",
"in": "query",
"name": "value_type",
"required": false,
"schema": {
"enum": [
"string",
"integer",
"decimal",
"choice"
],
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"metafields"
]
},
"post": {
"operationId": "metafields_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"metafields"
]
}
},
"/metafields/{id}/": {
"delete": {
"operationId": "metafields_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this metafield.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"metafields"
]
},
"get": {
"operationId": "metafields_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this metafield.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"metafields"
]
},
"patch": {
"operationId": "metafields_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this metafield.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"metafields"
]
},
"put": {
"operationId": "metafields_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this metafield.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"metafields"
]
}
},
"/notification_templates/": {
"get": {
"operationId": "notification_templates_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "event",
"in": "query",
"name": "event",
"required": false,
"schema": {
"enum": [
"create",
"assign",
"unassign",
"reject",
"accept",
"unaccept",
"transit",
"activate",
"complete",
"fail",
"cancel",
"assignee_near",
"assignee_away",
"updated"
],
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "is_active",
"in": "query",
"name": "is_active",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "name",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "recipient",
"in": "query",
"name": "recipient",
"required": false,
"schema": {
"enum": [
"account",
"assignee",
"orderer",
"contact",
"client"
],
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "via_app",
"in": "query",
"name": "via_app",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "via_email",
"in": "query",
"name": "via_email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "via_sms",
"in": "query",
"name": "via_sms",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notification_templates"
]
},
"post": {
"operationId": "notification_templates_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notification_templates"
]
}
},
"/notification_templates/{id}/": {
"delete": {
"operationId": "notification_templates_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this notification template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notification_templates"
]
},
"get": {
"operationId": "notification_templates_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this notification template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notification_templates"
]
},
"patch": {
"operationId": "notification_templates_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this notification template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notification_templates"
]
},
"put": {
"operationId": "notification_templates_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this notification template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notification_templates"
]
}
},
"/notification_templates/{id}/render/": {
"post": {
"operationId": "notification_templates_render_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this notification template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notification_templates"
]
}
},
"/notifications/": {
"get": {
"operationId": "notifications_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "event",
"in": "query",
"name": "event",
"required": false,
"schema": {
"enum": [
"create",
"assign",
"unassign",
"reject",
"accept",
"unaccept",
"transit",
"activate",
"complete",
"fail",
"cancel",
"assignee_near",
"assignee_away",
"updated"
],
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "recipient",
"in": "query",
"name": "recipient",
"required": false,
"schema": {
"enum": [
"account",
"assignee",
"orderer",
"contact",
"client"
],
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "task",
"in": "query",
"name": "task",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "via_app",
"in": "query",
"name": "via_app",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "via_email",
"in": "query",
"name": "via_email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "via_sms",
"in": "query",
"name": "via_sms",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notifications"
]
},
"post": {
"operationId": "notifications_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notifications"
]
}
},
"/notifications/{id}/": {
"get": {
"operationId": "notifications_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this notification.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"notifications"
]
}
},
"/orders/": {
"get": {
"operationId": "orders_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "external_id",
"in": "query",
"name": "external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "reference",
"in": "query",
"name": "reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/PaginatedOrderSerializerV2List"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"orders"
]
},
"post": {
"operationId": "orders_create",
"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
},
"responses": {
"201": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/OrderSerializerV2"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"orders"
]
}
},
"/orders/{id}/": {
"get": {
"operationId": "orders_retrieve",
"parameters": [
{
"description": "A UUID string identifying this order.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/OrderSerializerV2"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"orders"
]
},
"patch": {
"operationId": "orders_partial_update",
"parameters": [
{
"description": "A UUID string identifying this order.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/OrderSerializerV2"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"orders"
]
},
"put": {
"operationId": "orders_update",
"parameters": [
{
"description": "A UUID string identifying this order.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/OrderSerializerV2"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"orders"
]
}
},
"/password_change/": {
"post": {
"operationId": "password_change_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"password_change"
]
}
},
"/password_reset/": {
"post": {
"operationId": "password_reset_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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": ""
}
},
"tags": [
"password_reset"
]
}
},
"/password_reset_confirm/": {
"post": {
"operationId": "password_reset_confirm_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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": ""
}
},
"tags": [
"password_reset_confirm"
]
}
},
"/push_notifications/": {
"get": {
"operationId": "push_notifications_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "event",
"in": "query",
"name": "event",
"required": false,
"schema": {
"enum": [
"create",
"assign",
"unassign",
"reject",
"accept",
"unaccept",
"transit",
"activate",
"complete",
"fail",
"cancel",
"assignee_near",
"assignee_away",
"updated"
],
"type": "string"
}
},
{
"description": "event__in",
"in": "query",
"name": "event__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id",
"in": "query",
"name": "external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__icontains",
"in": "query",
"name": "external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "message",
"in": "query",
"name": "message",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "message__icontains",
"in": "query",
"name": "message__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "pending_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"queued",
"pending",
"failed",
"sent"
],
"type": "string"
}
},
{
"description": "state__in",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "subject",
"in": "query",
"name": "subject",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "subject__icontains",
"in": "query",
"name": "subject__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"push_notifications"
]
},
"post": {
"operationId": "push_notifications_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"push_notifications"
]
}
},
"/push_notifications/{id}/": {
"delete": {
"operationId": "push_notifications_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this push notification.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"push_notifications"
]
},
"get": {
"operationId": "push_notifications_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this push notification.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"push_notifications"
]
},
"patch": {
"operationId": "push_notifications_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this push notification.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"push_notifications"
]
},
"put": {
"operationId": "push_notifications_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this push notification.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"push_notifications"
]
}
},
"/push_notifications/{id}/resend/": {
"post": {
"operationId": "push_notifications_resend_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this push notification.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"push_notifications"
]
}
},
"/recurrences/": {
"get": {
"operationId": "recurrences_list",
"parameters": [
{
"in": "query",
"name": "account",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "account__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Old implementation, indicating weather the task will be assigned to an assignee on recurrence",
"example": true,
"in": "query",
"name": "assign_worker",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "assignee__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "is_active",
"in": "query",
"name": "is_active",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "Filter by order and previous orders",
"example": "4c25e31f-3a5a-4d52-8531-20c3e8549df0",
"in": "query",
"name": "order",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__address__formatted_address__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__address__formatted_address__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__address__formatted_address__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__category__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__category__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__company__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__company__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__company__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__emails__contains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__emails__isnull",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__name__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__name__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__name__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__notes__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__notes__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__phones__contains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__phones__isnull",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__description__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__state__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__state__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/PaginatedRecurrenceList"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"recurrences"
]
},
"post": {
"operationId": "recurrences_create",
"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
},
"responses": {
"201": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/Recurrence"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"recurrences"
]
}
},
"/recurrences/{id}/": {
"get": {
"operationId": "recurrences_retrieve",
"parameters": [
{
"description": "A UUID string identifying this recurrence.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/Recurrence"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"recurrences"
]
},
"patch": {
"operationId": "recurrences_partial_update",
"parameters": [
{
"description": "A UUID string identifying this recurrence.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/Recurrence"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"recurrences"
]
},
"put": {
"operationId": "recurrences_update",
"parameters": [
{
"description": "A UUID string identifying this recurrence.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/Recurrence"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"recurrences"
]
}
},
"/register/": {
"post": {
"operationId": "register_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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": ""
}
},
"tags": [
"register"
]
}
},
"/reports/tasks/states_count/": {
"get": {
"operationId": "reports_tasks_states_count_retrieve",
"parameters": [
{
"in": "query",
"name": "account",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "assignee",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "User UUID-s list. Comma separated value",
"examples": {
"Example": {
"summary": "example",
"value": "16a0a96b-90cc-4b73-8a00-57ac8c8393c0,4b6cf9e2-1dbb-4f50-84c8-d0c188be7154"
}
},
"in": "query",
"name": "assignee__in",
"schema": {
"type": "string"
}
},
{
"examples": {
"DateFrom": {
"summary": "date_from",
"value": "2022-05-24"
}
},
"in": "query",
"name": "date_from",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
},
{
"examples": {
"DateUntil": {
"summary": "date_until",
"value": "2022-05-24"
}
},
"in": "query",
"name": "date_until",
"required": true,
"schema": {
"format": "date",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"in": "query",
"name": "timezone",
"schema": {
"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"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"reports"
]
}
},
"/reviews/": {
"get": {
"operationId": "reviews_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "tracker",
"in": "query",
"name": "tracker",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"reviews"
]
},
"post": {
"operationId": "reviews_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
},
{}
],
"tags": [
"reviews"
]
}
},
"/reviews/{id}/": {
"get": {
"operationId": "reviews_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this review.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"reviews"
]
}
},
"/route_optimizations/": {
"get": {
"operationId": "route_optimizations_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignees__id__in",
"in": "query",
"name": "assignees__id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "commited_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "objective",
"in": "query",
"name": "objective",
"required": false,
"schema": {
"enum": [
"vehicles",
"transport_time",
"completion_time"
],
"type": "string"
}
},
{
"description": "objective__in",
"in": "query",
"name": "objective__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "ready_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"pending",
"started",
"ready",
"completed",
"over_quota",
"failed"
],
"type": "string"
}
},
{
"description": "state__in",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "total_distance__gt",
"in": "query",
"name": "total_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "total_distance__gte",
"in": "query",
"name": "total_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "total_distance__lt",
"in": "query",
"name": "total_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "total_distance__lte",
"in": "query",
"name": "total_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "total_duration__gt",
"in": "query",
"name": "total_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "total_duration__gte",
"in": "query",
"name": "total_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "total_duration__lt",
"in": "query",
"name": "total_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "total_duration__lte",
"in": "query",
"name": "total_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"route_optimizations"
]
},
"post": {
"operationId": "route_optimizations_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"route_optimizations"
]
}
},
"/route_optimizations/{id}/": {
"get": {
"operationId": "route_optimizations_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this route optimization.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"route_optimizations"
]
}
},
"/route_optimizations/{id}/commit/": {
"post": {
"operationId": "route_optimizations_commit_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this route optimization.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"route_optimizations"
]
}
},
"/route_optimizations/{id}/results/": {
"get": {
"operationId": "route_optimizations_results_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this route optimization.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"route_optimizations"
]
}
},
"/route_optimizations/{id}/routes/": {
"get": {
"operationId": "route_optimizations_routes_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this route optimization.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"route_optimizations"
]
},
"post": {
"operationId": "route_optimizations_routes_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this route optimization.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"route_optimizations"
]
}
},
"/route_optimizations/{id}/schedule/": {
"post": {
"operationId": "route_optimizations_schedule_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this route optimization.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"route_optimizations"
]
}
},
"/routes/": {
"get": {
"operationId": "routes_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee",
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "code",
"in": "query",
"name": "code",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/PaginatedRouteList"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"routes"
]
},
"post": {
"operationId": "routes_create",
"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
},
"responses": {
"201": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/Route"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"routes"
]
}
},
"/routes/{id}/": {
"delete": {
"operationId": "routes_destroy",
"parameters": [
{
"description": "A UUID string identifying this route.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"routes"
]
},
"get": {
"operationId": "routes_retrieve",
"parameters": [
{
"description": "A UUID string identifying this route.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/Route"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"routes"
]
},
"patch": {
"operationId": "routes_partial_update",
"parameters": [
{
"description": "A UUID string identifying this route.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/Route"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"routes"
]
},
"put": {
"operationId": "routes_update",
"parameters": [
{
"description": "A UUID string identifying this route.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/Route"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"routes"
]
}
},
"/scenes/dashboard/": {
"get": {
"operationId": "scenes_dashboard_list",
"parameters": [
{
"in": "query",
"name": "account",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "account__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number",
"in": "query",
"name": "address__apartment_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__icontains",
"in": "query",
"name": "address__apartment_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__in",
"in": "query",
"name": "address__apartment_number__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__iregex",
"in": "query",
"name": "address__apartment_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__istartswith",
"in": "query",
"name": "address__apartment_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__search",
"in": "query",
"name": "address__apartment_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city",
"in": "query",
"name": "address__city",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__icontains",
"in": "query",
"name": "address__city__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__in",
"in": "query",
"name": "address__city__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__iregex",
"in": "query",
"name": "address__city__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__istartswith",
"in": "query",
"name": "address__city__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__search",
"in": "query",
"name": "address__city__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country",
"in": "query",
"name": "address__country",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__icontains",
"in": "query",
"name": "address__country__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__in",
"in": "query",
"name": "address__country__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__iregex",
"in": "query",
"name": "address__country__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__istartswith",
"in": "query",
"name": "address__country__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__search",
"in": "query",
"name": "address__country__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code",
"in": "query",
"name": "address__country_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__icontains",
"in": "query",
"name": "address__country_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__in",
"in": "query",
"name": "address__country_code__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__iregex",
"in": "query",
"name": "address__country_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__istartswith",
"in": "query",
"name": "address__country_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__search",
"in": "query",
"name": "address__country_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address",
"in": "query",
"name": "address__formatted_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__icontains",
"in": "query",
"name": "address__formatted_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__in",
"in": "query",
"name": "address__formatted_address__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__iregex",
"in": "query",
"name": "address__formatted_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__istartswith",
"in": "query",
"name": "address__formatted_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__search",
"in": "query",
"name": "address__formatted_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "address__google_place_id",
"in": "query",
"name": "address__google_place_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__icontains",
"in": "query",
"name": "address__google_place_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__in",
"in": "query",
"name": "address__google_place_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__iregex",
"in": "query",
"name": "address__google_place_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__istartswith",
"in": "query",
"name": "address__google_place_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__search",
"in": "query",
"name": "address__google_place_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number",
"in": "query",
"name": "address__house_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__icontains",
"in": "query",
"name": "address__house_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__in",
"in": "query",
"name": "address__house_number__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__iregex",
"in": "query",
"name": "address__house_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__istartswith",
"in": "query",
"name": "address__house_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__search",
"in": "query",
"name": "address__house_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest",
"in": "query",
"name": "address__point_of_interest",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__icontains",
"in": "query",
"name": "address__point_of_interest__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__in",
"in": "query",
"name": "address__point_of_interest__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__iregex",
"in": "query",
"name": "address__point_of_interest__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__istartswith",
"in": "query",
"name": "address__point_of_interest__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__search",
"in": "query",
"name": "address__point_of_interest__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code",
"in": "query",
"name": "address__postal_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__icontains",
"in": "query",
"name": "address__postal_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__in",
"in": "query",
"name": "address__postal_code__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__iregex",
"in": "query",
"name": "address__postal_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__istartswith",
"in": "query",
"name": "address__postal_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__search",
"in": "query",
"name": "address__postal_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address",
"in": "query",
"name": "address__raw_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__icontains",
"in": "query",
"name": "address__raw_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__in",
"in": "query",
"name": "address__raw_address__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__iregex",
"in": "query",
"name": "address__raw_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__istartswith",
"in": "query",
"name": "address__raw_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__search",
"in": "query",
"name": "address__raw_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state",
"in": "query",
"name": "address__state",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__icontains",
"in": "query",
"name": "address__state__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__in",
"in": "query",
"name": "address__state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__iregex",
"in": "query",
"name": "address__state__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__istartswith",
"in": "query",
"name": "address__state__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__search",
"in": "query",
"name": "address__state__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street",
"in": "query",
"name": "address__street",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__icontains",
"in": "query",
"name": "address__street__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__in",
"in": "query",
"name": "address__street__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__iregex",
"in": "query",
"name": "address__street__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__istartswith",
"in": "query",
"name": "address__street__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__search",
"in": "query",
"name": "address__street__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "address_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id",
"in": "query",
"name": "address_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id__in",
"in": "query",
"name": "address_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id__isnull",
"in": "query",
"name": "address_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "assignee__email",
"in": "query",
"name": "assignee__email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__icontains",
"in": "query",
"name": "assignee__email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__iregex",
"in": "query",
"name": "assignee__email__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__isnull",
"in": "query",
"name": "assignee__email__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__istartswith",
"in": "query",
"name": "assignee__email__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__search",
"in": "query",
"name": "assignee__email__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name",
"in": "query",
"name": "assignee__first_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__icontains",
"in": "query",
"name": "assignee__first_name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__iregex",
"in": "query",
"name": "assignee__first_name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__isnull",
"in": "query",
"name": "assignee__first_name__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__istartswith",
"in": "query",
"name": "assignee__first_name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__search",
"in": "query",
"name": "assignee__first_name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "assignee__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name",
"in": "query",
"name": "assignee__last_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__icontains",
"in": "query",
"name": "assignee__last_name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__iregex",
"in": "query",
"name": "assignee__last_name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__isnull",
"in": "query",
"name": "assignee__last_name__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__istartswith",
"in": "query",
"name": "assignee__last_name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__search",
"in": "query",
"name": "assignee__last_name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone",
"in": "query",
"name": "assignee__phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__icontains",
"in": "query",
"name": "assignee__phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__iregex",
"in": "query",
"name": "assignee__phone__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__isnull",
"in": "query",
"name": "assignee__phone__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__istartswith",
"in": "query",
"name": "assignee__phone__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__search",
"in": "query",
"name": "assignee__phone__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id",
"in": "query",
"name": "assignee_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id__in",
"in": "query",
"name": "assignee_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id__isnull",
"in": "query",
"name": "assignee_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_proximity",
"in": "query",
"name": "assignee_proximity",
"required": false,
"schema": {
"enum": [
"away",
"near"
],
"type": "string"
}
},
{
"description": "assignee_proximity__in",
"in": "query",
"name": "assignee_proximity__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "barcodes__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "category",
"in": "query",
"name": "category",
"required": false,
"schema": {
"enum": [
"assignment",
"pick_up",
"drop_off",
"warehouse"
],
"type": "string"
}
},
{
"description": "category__in",
"in": "query",
"name": "category__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "contact__company__icontains",
"in": "query",
"name": "contact__company__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__in",
"in": "query",
"name": "contact__company__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__iregex",
"in": "query",
"name": "contact__company__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__istartswith",
"in": "query",
"name": "contact__company__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__search",
"in": "query",
"name": "contact__company__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email",
"in": "query",
"name": "contact__email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__icontains",
"in": "query",
"name": "contact__email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__in",
"in": "query",
"name": "contact__email__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__iregex",
"in": "query",
"name": "contact__email__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__istartswith",
"in": "query",
"name": "contact__email__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__search",
"in": "query",
"name": "contact__email__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__emails__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name",
"in": "query",
"name": "contact__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__icontains",
"in": "query",
"name": "contact__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__in",
"in": "query",
"name": "contact__name__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__iregex",
"in": "query",
"name": "contact__name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__istartswith",
"in": "query",
"name": "contact__name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__search",
"in": "query",
"name": "contact__name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes",
"in": "query",
"name": "contact__notes",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__icontains",
"in": "query",
"name": "contact__notes__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__in",
"in": "query",
"name": "contact__notes__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__iregex",
"in": "query",
"name": "contact__notes__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__istartswith",
"in": "query",
"name": "contact__notes__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__search",
"in": "query",
"name": "contact__notes__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone",
"in": "query",
"name": "contact__phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__icontains",
"in": "query",
"name": "contact__phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__in",
"in": "query",
"name": "contact__phone__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__iregex",
"in": "query",
"name": "contact__phone__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__istartswith",
"in": "query",
"name": "contact__phone__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__search",
"in": "query",
"name": "contact__phone__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__phones__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "contact_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id",
"in": "query",
"name": "contact_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id__in",
"in": "query",
"name": "contact_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id__isnull",
"in": "query",
"name": "contact_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "created_by",
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "created_by__in",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "created_by__isnull",
"in": "query",
"name": "created_by__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "description",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__icontains",
"in": "query",
"name": "description__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__iregex",
"in": "query",
"name": "description__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__istartswith",
"in": "query",
"name": "description__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__search",
"in": "query",
"name": "description__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration",
"in": "query",
"name": "duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__gt",
"in": "query",
"name": "duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__gte",
"in": "query",
"name": "duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__lt",
"in": "query",
"name": "duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__lte",
"in": "query",
"name": "duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id",
"in": "query",
"name": "external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__icontains",
"in": "query",
"name": "external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__in",
"in": "query",
"name": "external_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__iregex",
"in": "query",
"name": "external_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__isnull",
"in": "query",
"name": "external_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__istartswith",
"in": "query",
"name": "external_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__search",
"in": "query",
"name": "external_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "id__in",
"in": "query",
"name": "id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_optimal",
"in": "query",
"name": "is_optimal",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_optimal__isnull",
"in": "query",
"name": "is_optimal__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance",
"in": "query",
"name": "metadata__accepted_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__gt",
"in": "query",
"name": "metadata__accepted_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__gte",
"in": "query",
"name": "metadata__accepted_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__lt",
"in": "query",
"name": "metadata__accepted_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__lte",
"in": "query",
"name": "metadata__accepted_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration",
"in": "query",
"name": "metadata__accepted_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__gt",
"in": "query",
"name": "metadata__accepted_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__gte",
"in": "query",
"name": "metadata__accepted_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__lt",
"in": "query",
"name": "metadata__accepted_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__lte",
"in": "query",
"name": "metadata__accepted_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance",
"in": "query",
"name": "metadata__active_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__gt",
"in": "query",
"name": "metadata__active_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__gte",
"in": "query",
"name": "metadata__active_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__lt",
"in": "query",
"name": "metadata__active_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__lte",
"in": "query",
"name": "metadata__active_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration",
"in": "query",
"name": "metadata__active_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__gt",
"in": "query",
"name": "metadata__active_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__gte",
"in": "query",
"name": "metadata__active_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__lt",
"in": "query",
"name": "metadata__active_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__lte",
"in": "query",
"name": "metadata__active_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance",
"in": "query",
"name": "metadata__assigned_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__gt",
"in": "query",
"name": "metadata__assigned_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__gte",
"in": "query",
"name": "metadata__assigned_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__lt",
"in": "query",
"name": "metadata__assigned_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__lte",
"in": "query",
"name": "metadata__assigned_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration",
"in": "query",
"name": "metadata__assigned_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__gt",
"in": "query",
"name": "metadata__assigned_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__gte",
"in": "query",
"name": "metadata__assigned_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__lt",
"in": "query",
"name": "metadata__assigned_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__lte",
"in": "query",
"name": "metadata__assigned_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance",
"in": "query",
"name": "metadata__cancelled_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__gt",
"in": "query",
"name": "metadata__cancelled_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__gte",
"in": "query",
"name": "metadata__cancelled_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__lt",
"in": "query",
"name": "metadata__cancelled_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__lte",
"in": "query",
"name": "metadata__cancelled_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration",
"in": "query",
"name": "metadata__cancelled_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__gt",
"in": "query",
"name": "metadata__cancelled_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__gte",
"in": "query",
"name": "metadata__cancelled_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__lt",
"in": "query",
"name": "metadata__cancelled_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__lte",
"in": "query",
"name": "metadata__cancelled_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance",
"in": "query",
"name": "metadata__completed_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__gt",
"in": "query",
"name": "metadata__completed_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__gte",
"in": "query",
"name": "metadata__completed_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__lt",
"in": "query",
"name": "metadata__completed_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__lte",
"in": "query",
"name": "metadata__completed_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration",
"in": "query",
"name": "metadata__completed_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__gt",
"in": "query",
"name": "metadata__completed_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__gte",
"in": "query",
"name": "metadata__completed_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__lt",
"in": "query",
"name": "metadata__completed_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__lte",
"in": "query",
"name": "metadata__completed_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count",
"in": "query",
"name": "metadata__documents_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__gt",
"in": "query",
"name": "metadata__documents_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__gte",
"in": "query",
"name": "metadata__documents_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__lt",
"in": "query",
"name": "metadata__documents_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__lte",
"in": "query",
"name": "metadata__documents_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count",
"in": "query",
"name": "metadata__events_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__gt",
"in": "query",
"name": "metadata__events_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__gte",
"in": "query",
"name": "metadata__events_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__lt",
"in": "query",
"name": "metadata__events_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__lte",
"in": "query",
"name": "metadata__events_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance",
"in": "query",
"name": "metadata__failed_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__gt",
"in": "query",
"name": "metadata__failed_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__gte",
"in": "query",
"name": "metadata__failed_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__lt",
"in": "query",
"name": "metadata__failed_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__lte",
"in": "query",
"name": "metadata__failed_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration",
"in": "query",
"name": "metadata__failed_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__gt",
"in": "query",
"name": "metadata__failed_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__gte",
"in": "query",
"name": "metadata__failed_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__lt",
"in": "query",
"name": "metadata__failed_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__lte",
"in": "query",
"name": "metadata__failed_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count",
"in": "query",
"name": "metadata__forms_completed_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__gt",
"in": "query",
"name": "metadata__forms_completed_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__gte",
"in": "query",
"name": "metadata__forms_completed_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__lt",
"in": "query",
"name": "metadata__forms_completed_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__lte",
"in": "query",
"name": "metadata__forms_completed_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count",
"in": "query",
"name": "metadata__forms_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__gt",
"in": "query",
"name": "metadata__forms_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__gte",
"in": "query",
"name": "metadata__forms_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__lt",
"in": "query",
"name": "metadata__forms_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__lte",
"in": "query",
"name": "metadata__forms_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "metadata__signatures_count",
"in": "query",
"name": "metadata__signatures_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__gt",
"in": "query",
"name": "metadata__signatures_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__gte",
"in": "query",
"name": "metadata__signatures_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__lt",
"in": "query",
"name": "metadata__signatures_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__lte",
"in": "query",
"name": "metadata__signatures_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count",
"in": "query",
"name": "metadata__task_event_notes_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__gt",
"in": "query",
"name": "metadata__task_event_notes_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__gte",
"in": "query",
"name": "metadata__task_event_notes_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__lt",
"in": "query",
"name": "metadata__task_event_notes_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__lte",
"in": "query",
"name": "metadata__task_event_notes_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance",
"in": "query",
"name": "metadata__transit_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__gt",
"in": "query",
"name": "metadata__transit_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__gte",
"in": "query",
"name": "metadata__transit_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__lt",
"in": "query",
"name": "metadata__transit_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__lte",
"in": "query",
"name": "metadata__transit_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration",
"in": "query",
"name": "metadata__transit_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__gt",
"in": "query",
"name": "metadata__transit_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__gte",
"in": "query",
"name": "metadata__transit_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__lt",
"in": "query",
"name": "metadata__transit_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__lte",
"in": "query",
"name": "metadata__transit_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance",
"in": "query",
"name": "metadata__unassigned_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__gt",
"in": "query",
"name": "metadata__unassigned_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__gte",
"in": "query",
"name": "metadata__unassigned_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__lt",
"in": "query",
"name": "metadata__unassigned_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__lte",
"in": "query",
"name": "metadata__unassigned_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration",
"in": "query",
"name": "metadata__unassigned_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__gt",
"in": "query",
"name": "metadata__unassigned_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__gte",
"in": "query",
"name": "metadata__unassigned_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__lt",
"in": "query",
"name": "metadata__unassigned_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__lte",
"in": "query",
"name": "metadata__unassigned_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "metafields__namespace:key",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "order",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "order__auto_assign",
"in": "query",
"name": "order__auto_assign",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "order__created_by",
"in": "query",
"name": "order__created_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__created_by__in",
"in": "query",
"name": "order__created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__created_by__isnull",
"in": "query",
"name": "order__created_by__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id",
"in": "query",
"name": "order__external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__icontains",
"in": "query",
"name": "order__external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__in",
"in": "query",
"name": "order__external_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__iregex",
"in": "query",
"name": "order__external_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__isnull",
"in": "query",
"name": "order__external_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__istartswith",
"in": "query",
"name": "order__external_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__search",
"in": "query",
"name": "order__external_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "order__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "order__orderer",
"required": false,
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
},
{
"description": "order__reference",
"in": "query",
"name": "order__reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__icontains",
"in": "query",
"name": "order__reference__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__in",
"in": "query",
"name": "order__reference__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__iregex",
"in": "query",
"name": "order__reference__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__istartswith",
"in": "query",
"name": "order__reference__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__search",
"in": "query",
"name": "order__reference__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id",
"in": "query",
"name": "order_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id__in",
"in": "query",
"name": "order_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id__isnull",
"in": "query",
"name": "order_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderer",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "orderer__id",
"in": "query",
"name": "orderer__id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__id__in",
"in": "query",
"name": "orderer__id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__id__isnull",
"in": "query",
"name": "orderer__id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "orderer__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__name",
"in": "query",
"name": "orderer__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__name__icontains",
"in": "query",
"name": "orderer__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id",
"in": "query",
"name": "orderer_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id__in",
"in": "query",
"name": "orderer_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id__isnull",
"in": "query",
"name": "orderer_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id",
"in": "query",
"name": "owner_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id__in",
"in": "query",
"name": "owner_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id__isnull",
"in": "query",
"name": "owner_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated UUID values supported",
"example": "d496b7fd-b2c9-40a8-835e-6a74c8350cf3,13bf175a-47c5-4e3b-9766-4a0fe715a83b",
"in": "query",
"name": "previous_assignees__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated UUID values supported",
"example": "d496b7fd-b2c9-40a8-835e-6a74c8350cf3,13bf175a-47c5-4e3b-9766-4a0fe715a83b",
"in": "query",
"name": "previous_assignees__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "previous_assignees__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated UUID values supported",
"example": "d496b7fd-b2c9-40a8-835e-6a74c8350cf3,13bf175a-47c5-4e3b-9766-4a0fe715a83b",
"in": "query",
"name": "previous_assignees__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority",
"in": "query",
"name": "priority",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__gt",
"in": "query",
"name": "priority__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__gte",
"in": "query",
"name": "priority__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__in",
"in": "query",
"name": "priority__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__lt",
"in": "query",
"name": "priority__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__lte",
"in": "query",
"name": "priority__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "receiver",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "receiver__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id",
"in": "query",
"name": "receiver_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id__in",
"in": "query",
"name": "receiver_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id__isnull",
"in": "query",
"name": "receiver_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference",
"in": "query",
"name": "reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__icontains",
"in": "query",
"name": "reference__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__in",
"in": "query",
"name": "reference__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__iregex",
"in": "query",
"name": "reference__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__istartswith",
"in": "query",
"name": "reference__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__search",
"in": "query",
"name": "reference__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "route",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "route__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id",
"in": "query",
"name": "route_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id__in",
"in": "query",
"name": "route_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id__isnull",
"in": "query",
"name": "route_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "size__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled"
],
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "task_import",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "task_import__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id",
"in": "query",
"name": "unassignee_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id__in",
"in": "query",
"name": "unassignee_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id__isnull",
"in": "query",
"name": "unassignee_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"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,
"in": "query",
"name": "updated_at_delay_latest",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"scenes"
]
}
},
"/scenes/order_list/": {
"get": {
"operationId": "scenes_order_list_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "external_id",
"in": "query",
"name": "external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "reference",
"in": "query",
"name": "reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/PaginatedOrderListSceneList"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"scenes"
]
}
},
"/scenes/recurrence_list/": {
"get": {
"operationId": "scenes_recurrence_list_list",
"parameters": [
{
"in": "query",
"name": "account",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "account__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Old implementation, indicating weather the task will be assigned to an assignee on recurrence",
"example": true,
"in": "query",
"name": "assign_worker",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "assignee__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "is_active",
"in": "query",
"name": "is_active",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_errored_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_recurred_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "last_scheduled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "next_scheduled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "Filter by order and previous orders",
"example": "626b6833-1f73-4270-98d6-34cd7d2fc7d1",
"in": "query",
"name": "order",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__address__formatted_address__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__address__formatted_address__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__address__formatted_address__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__category__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__category__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__company__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__company__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__company__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__emails__contains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__emails__isnull",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__name__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__name__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__name__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__notes__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__notes__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__phones__contains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__contact__phones__isnull",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__description__icontains",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__state__exact",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "some_value",
"in": "query",
"name": "tasks_data__state__in",
"required": false,
"schema": {
"format": "string",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"$ref": "#/components/schemas/PaginatedRecurrenceListSceneList"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"scenes"
]
}
},
"/scenes/task_list/": {
"get": {
"operationId": "scenes_task_list_list",
"parameters": [
{
"in": "query",
"name": "account",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "account__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number",
"in": "query",
"name": "address__apartment_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__icontains",
"in": "query",
"name": "address__apartment_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__in",
"in": "query",
"name": "address__apartment_number__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__iregex",
"in": "query",
"name": "address__apartment_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__istartswith",
"in": "query",
"name": "address__apartment_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__search",
"in": "query",
"name": "address__apartment_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city",
"in": "query",
"name": "address__city",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__icontains",
"in": "query",
"name": "address__city__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__in",
"in": "query",
"name": "address__city__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__iregex",
"in": "query",
"name": "address__city__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__istartswith",
"in": "query",
"name": "address__city__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__search",
"in": "query",
"name": "address__city__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country",
"in": "query",
"name": "address__country",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__icontains",
"in": "query",
"name": "address__country__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__in",
"in": "query",
"name": "address__country__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__iregex",
"in": "query",
"name": "address__country__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__istartswith",
"in": "query",
"name": "address__country__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__search",
"in": "query",
"name": "address__country__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code",
"in": "query",
"name": "address__country_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__icontains",
"in": "query",
"name": "address__country_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__in",
"in": "query",
"name": "address__country_code__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__iregex",
"in": "query",
"name": "address__country_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__istartswith",
"in": "query",
"name": "address__country_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__search",
"in": "query",
"name": "address__country_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address",
"in": "query",
"name": "address__formatted_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__icontains",
"in": "query",
"name": "address__formatted_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__in",
"in": "query",
"name": "address__formatted_address__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__iregex",
"in": "query",
"name": "address__formatted_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__istartswith",
"in": "query",
"name": "address__formatted_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__search",
"in": "query",
"name": "address__formatted_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "address__google_place_id",
"in": "query",
"name": "address__google_place_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__icontains",
"in": "query",
"name": "address__google_place_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__in",
"in": "query",
"name": "address__google_place_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__iregex",
"in": "query",
"name": "address__google_place_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__istartswith",
"in": "query",
"name": "address__google_place_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__search",
"in": "query",
"name": "address__google_place_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number",
"in": "query",
"name": "address__house_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__icontains",
"in": "query",
"name": "address__house_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__in",
"in": "query",
"name": "address__house_number__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__iregex",
"in": "query",
"name": "address__house_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__istartswith",
"in": "query",
"name": "address__house_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__search",
"in": "query",
"name": "address__house_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest",
"in": "query",
"name": "address__point_of_interest",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__icontains",
"in": "query",
"name": "address__point_of_interest__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__in",
"in": "query",
"name": "address__point_of_interest__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__iregex",
"in": "query",
"name": "address__point_of_interest__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__istartswith",
"in": "query",
"name": "address__point_of_interest__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__search",
"in": "query",
"name": "address__point_of_interest__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code",
"in": "query",
"name": "address__postal_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__icontains",
"in": "query",
"name": "address__postal_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__in",
"in": "query",
"name": "address__postal_code__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__iregex",
"in": "query",
"name": "address__postal_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__istartswith",
"in": "query",
"name": "address__postal_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__search",
"in": "query",
"name": "address__postal_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address",
"in": "query",
"name": "address__raw_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__icontains",
"in": "query",
"name": "address__raw_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__in",
"in": "query",
"name": "address__raw_address__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__iregex",
"in": "query",
"name": "address__raw_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__istartswith",
"in": "query",
"name": "address__raw_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__search",
"in": "query",
"name": "address__raw_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state",
"in": "query",
"name": "address__state",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__icontains",
"in": "query",
"name": "address__state__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__in",
"in": "query",
"name": "address__state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__iregex",
"in": "query",
"name": "address__state__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__istartswith",
"in": "query",
"name": "address__state__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__search",
"in": "query",
"name": "address__state__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street",
"in": "query",
"name": "address__street",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__icontains",
"in": "query",
"name": "address__street__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__in",
"in": "query",
"name": "address__street__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__iregex",
"in": "query",
"name": "address__street__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__istartswith",
"in": "query",
"name": "address__street__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__search",
"in": "query",
"name": "address__street__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "address_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id",
"in": "query",
"name": "address_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id__in",
"in": "query",
"name": "address_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id__isnull",
"in": "query",
"name": "address_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "assignee__email",
"in": "query",
"name": "assignee__email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__icontains",
"in": "query",
"name": "assignee__email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__iregex",
"in": "query",
"name": "assignee__email__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__isnull",
"in": "query",
"name": "assignee__email__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__istartswith",
"in": "query",
"name": "assignee__email__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__search",
"in": "query",
"name": "assignee__email__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name",
"in": "query",
"name": "assignee__first_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__icontains",
"in": "query",
"name": "assignee__first_name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__iregex",
"in": "query",
"name": "assignee__first_name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__isnull",
"in": "query",
"name": "assignee__first_name__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__istartswith",
"in": "query",
"name": "assignee__first_name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__search",
"in": "query",
"name": "assignee__first_name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "assignee__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name",
"in": "query",
"name": "assignee__last_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__icontains",
"in": "query",
"name": "assignee__last_name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__iregex",
"in": "query",
"name": "assignee__last_name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__isnull",
"in": "query",
"name": "assignee__last_name__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__istartswith",
"in": "query",
"name": "assignee__last_name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__search",
"in": "query",
"name": "assignee__last_name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone",
"in": "query",
"name": "assignee__phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__icontains",
"in": "query",
"name": "assignee__phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__iregex",
"in": "query",
"name": "assignee__phone__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__isnull",
"in": "query",
"name": "assignee__phone__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__istartswith",
"in": "query",
"name": "assignee__phone__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__search",
"in": "query",
"name": "assignee__phone__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id",
"in": "query",
"name": "assignee_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id__in",
"in": "query",
"name": "assignee_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id__isnull",
"in": "query",
"name": "assignee_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_proximity",
"in": "query",
"name": "assignee_proximity",
"required": false,
"schema": {
"enum": [
"away",
"near"
],
"type": "string"
}
},
{
"description": "assignee_proximity__in",
"in": "query",
"name": "assignee_proximity__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "barcodes__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "category",
"in": "query",
"name": "category",
"required": false,
"schema": {
"enum": [
"assignment",
"pick_up",
"drop_off",
"warehouse"
],
"type": "string"
}
},
{
"description": "category__in",
"in": "query",
"name": "category__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "contact__company__icontains",
"in": "query",
"name": "contact__company__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__in",
"in": "query",
"name": "contact__company__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__iregex",
"in": "query",
"name": "contact__company__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__istartswith",
"in": "query",
"name": "contact__company__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__search",
"in": "query",
"name": "contact__company__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email",
"in": "query",
"name": "contact__email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__icontains",
"in": "query",
"name": "contact__email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__in",
"in": "query",
"name": "contact__email__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__iregex",
"in": "query",
"name": "contact__email__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__istartswith",
"in": "query",
"name": "contact__email__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__search",
"in": "query",
"name": "contact__email__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__emails__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name",
"in": "query",
"name": "contact__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__icontains",
"in": "query",
"name": "contact__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__in",
"in": "query",
"name": "contact__name__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__iregex",
"in": "query",
"name": "contact__name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__istartswith",
"in": "query",
"name": "contact__name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__search",
"in": "query",
"name": "contact__name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes",
"in": "query",
"name": "contact__notes",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__icontains",
"in": "query",
"name": "contact__notes__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__in",
"in": "query",
"name": "contact__notes__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__iregex",
"in": "query",
"name": "contact__notes__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__istartswith",
"in": "query",
"name": "contact__notes__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__search",
"in": "query",
"name": "contact__notes__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone",
"in": "query",
"name": "contact__phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__icontains",
"in": "query",
"name": "contact__phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__in",
"in": "query",
"name": "contact__phone__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__iregex",
"in": "query",
"name": "contact__phone__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__istartswith",
"in": "query",
"name": "contact__phone__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__search",
"in": "query",
"name": "contact__phone__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__phones__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "contact_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id",
"in": "query",
"name": "contact_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id__in",
"in": "query",
"name": "contact_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id__isnull",
"in": "query",
"name": "contact_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "created_by",
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "created_by__in",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "created_by__isnull",
"in": "query",
"name": "created_by__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "description",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__icontains",
"in": "query",
"name": "description__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__iregex",
"in": "query",
"name": "description__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__istartswith",
"in": "query",
"name": "description__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__search",
"in": "query",
"name": "description__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration",
"in": "query",
"name": "duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__gt",
"in": "query",
"name": "duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__gte",
"in": "query",
"name": "duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__lt",
"in": "query",
"name": "duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__lte",
"in": "query",
"name": "duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id",
"in": "query",
"name": "external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__icontains",
"in": "query",
"name": "external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__in",
"in": "query",
"name": "external_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__iregex",
"in": "query",
"name": "external_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__isnull",
"in": "query",
"name": "external_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__istartswith",
"in": "query",
"name": "external_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__search",
"in": "query",
"name": "external_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "id__in",
"in": "query",
"name": "id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_optimal",
"in": "query",
"name": "is_optimal",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_optimal__isnull",
"in": "query",
"name": "is_optimal__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance",
"in": "query",
"name": "metadata__accepted_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__gt",
"in": "query",
"name": "metadata__accepted_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__gte",
"in": "query",
"name": "metadata__accepted_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__lt",
"in": "query",
"name": "metadata__accepted_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__lte",
"in": "query",
"name": "metadata__accepted_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration",
"in": "query",
"name": "metadata__accepted_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__gt",
"in": "query",
"name": "metadata__accepted_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__gte",
"in": "query",
"name": "metadata__accepted_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__lt",
"in": "query",
"name": "metadata__accepted_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__lte",
"in": "query",
"name": "metadata__accepted_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance",
"in": "query",
"name": "metadata__active_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__gt",
"in": "query",
"name": "metadata__active_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__gte",
"in": "query",
"name": "metadata__active_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__lt",
"in": "query",
"name": "metadata__active_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__lte",
"in": "query",
"name": "metadata__active_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration",
"in": "query",
"name": "metadata__active_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__gt",
"in": "query",
"name": "metadata__active_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__gte",
"in": "query",
"name": "metadata__active_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__lt",
"in": "query",
"name": "metadata__active_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__lte",
"in": "query",
"name": "metadata__active_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance",
"in": "query",
"name": "metadata__assigned_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__gt",
"in": "query",
"name": "metadata__assigned_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__gte",
"in": "query",
"name": "metadata__assigned_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__lt",
"in": "query",
"name": "metadata__assigned_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__lte",
"in": "query",
"name": "metadata__assigned_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration",
"in": "query",
"name": "metadata__assigned_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__gt",
"in": "query",
"name": "metadata__assigned_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__gte",
"in": "query",
"name": "metadata__assigned_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__lt",
"in": "query",
"name": "metadata__assigned_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__lte",
"in": "query",
"name": "metadata__assigned_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance",
"in": "query",
"name": "metadata__cancelled_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__gt",
"in": "query",
"name": "metadata__cancelled_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__gte",
"in": "query",
"name": "metadata__cancelled_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__lt",
"in": "query",
"name": "metadata__cancelled_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__lte",
"in": "query",
"name": "metadata__cancelled_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration",
"in": "query",
"name": "metadata__cancelled_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__gt",
"in": "query",
"name": "metadata__cancelled_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__gte",
"in": "query",
"name": "metadata__cancelled_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__lt",
"in": "query",
"name": "metadata__cancelled_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__lte",
"in": "query",
"name": "metadata__cancelled_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance",
"in": "query",
"name": "metadata__completed_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__gt",
"in": "query",
"name": "metadata__completed_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__gte",
"in": "query",
"name": "metadata__completed_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__lt",
"in": "query",
"name": "metadata__completed_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__lte",
"in": "query",
"name": "metadata__completed_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration",
"in": "query",
"name": "metadata__completed_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__gt",
"in": "query",
"name": "metadata__completed_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__gte",
"in": "query",
"name": "metadata__completed_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__lt",
"in": "query",
"name": "metadata__completed_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__lte",
"in": "query",
"name": "metadata__completed_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count",
"in": "query",
"name": "metadata__documents_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__gt",
"in": "query",
"name": "metadata__documents_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__gte",
"in": "query",
"name": "metadata__documents_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__lt",
"in": "query",
"name": "metadata__documents_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__lte",
"in": "query",
"name": "metadata__documents_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count",
"in": "query",
"name": "metadata__events_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__gt",
"in": "query",
"name": "metadata__events_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__gte",
"in": "query",
"name": "metadata__events_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__lt",
"in": "query",
"name": "metadata__events_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__lte",
"in": "query",
"name": "metadata__events_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance",
"in": "query",
"name": "metadata__failed_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__gt",
"in": "query",
"name": "metadata__failed_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__gte",
"in": "query",
"name": "metadata__failed_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__lt",
"in": "query",
"name": "metadata__failed_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__lte",
"in": "query",
"name": "metadata__failed_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration",
"in": "query",
"name": "metadata__failed_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__gt",
"in": "query",
"name": "metadata__failed_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__gte",
"in": "query",
"name": "metadata__failed_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__lt",
"in": "query",
"name": "metadata__failed_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__lte",
"in": "query",
"name": "metadata__failed_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count",
"in": "query",
"name": "metadata__forms_completed_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__gt",
"in": "query",
"name": "metadata__forms_completed_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__gte",
"in": "query",
"name": "metadata__forms_completed_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__lt",
"in": "query",
"name": "metadata__forms_completed_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__lte",
"in": "query",
"name": "metadata__forms_completed_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count",
"in": "query",
"name": "metadata__forms_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__gt",
"in": "query",
"name": "metadata__forms_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__gte",
"in": "query",
"name": "metadata__forms_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__lt",
"in": "query",
"name": "metadata__forms_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__lte",
"in": "query",
"name": "metadata__forms_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "metadata__signatures_count",
"in": "query",
"name": "metadata__signatures_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__gt",
"in": "query",
"name": "metadata__signatures_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__gte",
"in": "query",
"name": "metadata__signatures_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__lt",
"in": "query",
"name": "metadata__signatures_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__lte",
"in": "query",
"name": "metadata__signatures_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count",
"in": "query",
"name": "metadata__task_event_notes_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__gt",
"in": "query",
"name": "metadata__task_event_notes_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__gte",
"in": "query",
"name": "metadata__task_event_notes_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__lt",
"in": "query",
"name": "metadata__task_event_notes_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__lte",
"in": "query",
"name": "metadata__task_event_notes_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance",
"in": "query",
"name": "metadata__transit_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__gt",
"in": "query",
"name": "metadata__transit_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__gte",
"in": "query",
"name": "metadata__transit_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__lt",
"in": "query",
"name": "metadata__transit_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__lte",
"in": "query",
"name": "metadata__transit_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration",
"in": "query",
"name": "metadata__transit_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__gt",
"in": "query",
"name": "metadata__transit_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__gte",
"in": "query",
"name": "metadata__transit_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__lt",
"in": "query",
"name": "metadata__transit_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__lte",
"in": "query",
"name": "metadata__transit_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance",
"in": "query",
"name": "metadata__unassigned_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__gt",
"in": "query",
"name": "metadata__unassigned_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__gte",
"in": "query",
"name": "metadata__unassigned_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__lt",
"in": "query",
"name": "metadata__unassigned_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__lte",
"in": "query",
"name": "metadata__unassigned_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration",
"in": "query",
"name": "metadata__unassigned_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__gt",
"in": "query",
"name": "metadata__unassigned_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__gte",
"in": "query",
"name": "metadata__unassigned_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__lt",
"in": "query",
"name": "metadata__unassigned_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__lte",
"in": "query",
"name": "metadata__unassigned_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "metafields__namespace:key",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "order",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "order__auto_assign",
"in": "query",
"name": "order__auto_assign",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "order__created_by",
"in": "query",
"name": "order__created_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__created_by__in",
"in": "query",
"name": "order__created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__created_by__isnull",
"in": "query",
"name": "order__created_by__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id",
"in": "query",
"name": "order__external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__icontains",
"in": "query",
"name": "order__external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__in",
"in": "query",
"name": "order__external_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__iregex",
"in": "query",
"name": "order__external_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__isnull",
"in": "query",
"name": "order__external_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__istartswith",
"in": "query",
"name": "order__external_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__search",
"in": "query",
"name": "order__external_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "order__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "order__orderer",
"required": false,
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
},
{
"description": "order__reference",
"in": "query",
"name": "order__reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__icontains",
"in": "query",
"name": "order__reference__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__in",
"in": "query",
"name": "order__reference__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__iregex",
"in": "query",
"name": "order__reference__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__istartswith",
"in": "query",
"name": "order__reference__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__search",
"in": "query",
"name": "order__reference__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id",
"in": "query",
"name": "order_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id__in",
"in": "query",
"name": "order_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id__isnull",
"in": "query",
"name": "order_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderer",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "orderer__id",
"in": "query",
"name": "orderer__id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__id__in",
"in": "query",
"name": "orderer__id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__id__isnull",
"in": "query",
"name": "orderer__id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "orderer__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__name",
"in": "query",
"name": "orderer__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__name__icontains",
"in": "query",
"name": "orderer__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id",
"in": "query",
"name": "orderer_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id__in",
"in": "query",
"name": "orderer_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id__isnull",
"in": "query",
"name": "orderer_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id",
"in": "query",
"name": "owner_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id__in",
"in": "query",
"name": "owner_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id__isnull",
"in": "query",
"name": "owner_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated UUID values supported",
"example": "16c40a37-295b-4ca5-a6c0-7edb04bbf60e,a2bfdc09-39f3-40d1-8f09-8144b4692bab",
"in": "query",
"name": "previous_assignees__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated UUID values supported",
"example": "16c40a37-295b-4ca5-a6c0-7edb04bbf60e,a2bfdc09-39f3-40d1-8f09-8144b4692bab",
"in": "query",
"name": "previous_assignees__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "previous_assignees__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated UUID values supported",
"example": "16c40a37-295b-4ca5-a6c0-7edb04bbf60e,a2bfdc09-39f3-40d1-8f09-8144b4692bab",
"in": "query",
"name": "previous_assignees__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority",
"in": "query",
"name": "priority",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__gt",
"in": "query",
"name": "priority__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__gte",
"in": "query",
"name": "priority__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__in",
"in": "query",
"name": "priority__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__lt",
"in": "query",
"name": "priority__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__lte",
"in": "query",
"name": "priority__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "receiver",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "receiver__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id",
"in": "query",
"name": "receiver_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id__in",
"in": "query",
"name": "receiver_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id__isnull",
"in": "query",
"name": "receiver_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference",
"in": "query",
"name": "reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__icontains",
"in": "query",
"name": "reference__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__in",
"in": "query",
"name": "reference__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__iregex",
"in": "query",
"name": "reference__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__istartswith",
"in": "query",
"name": "reference__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__search",
"in": "query",
"name": "reference__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "route",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "route__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id",
"in": "query",
"name": "route_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id__in",
"in": "query",
"name": "route_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id__isnull",
"in": "query",
"name": "route_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "size__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled"
],
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "task_import",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "task_import__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id",
"in": "query",
"name": "unassignee_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id__in",
"in": "query",
"name": "unassignee_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id__isnull",
"in": "query",
"name": "unassignee_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"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,
"in": "query",
"name": "updated_at_delay_latest",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"scenes"
]
}
},
"/signatures/": {
"get": {
"operationId": "signatures_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "filename",
"in": "query",
"name": "filename",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__iexact",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "filename__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "mimetype",
"in": "query",
"name": "mimetype",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "source",
"in": "query",
"name": "source",
"required": false,
"schema": {
"enum": [
"web",
"mobile",
"integration"
],
"type": "string"
}
},
{
"description": "task",
"in": "query",
"name": "task",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"signatures"
]
},
"post": {
"operationId": "signatures_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"signatures"
]
}
},
"/signatures/batch_delete/": {
"post": {
"description": "Available from version 2.4.2",
"operationId": "signatures_batch_delete_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"signatures"
]
}
},
"/signatures/{id}/": {
"delete": {
"operationId": "signatures_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this signature.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"signatures"
]
},
"get": {
"operationId": "signatures_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this signature.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"signatures"
]
}
},
"/sms/": {
"get": {
"operationId": "sms_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "alphanumeric_sender_id",
"in": "query",
"name": "alphanumeric_sender_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "alphanumeric_sender_id__icontains",
"in": "query",
"name": "alphanumeric_sender_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "message",
"in": "query",
"name": "message",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "message__icontains",
"in": "query",
"name": "message__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "phone",
"in": "query",
"name": "phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "phone__icontains",
"in": "query",
"name": "phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "price",
"in": "query",
"name": "price",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "price__gt",
"in": "query",
"name": "price__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "price__gte",
"in": "query",
"name": "price__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "price__lt",
"in": "query",
"name": "price__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "price__lte",
"in": "query",
"name": "price__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "provider",
"in": "query",
"name": "provider",
"required": false,
"schema": {
"enum": [
"twilio",
"smsapi"
],
"type": "string"
}
},
{
"description": "provider__in",
"in": "query",
"name": "provider__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "received_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "segments_count",
"in": "query",
"name": "segments_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "segments_count__gt",
"in": "query",
"name": "segments_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "segments_count__gte",
"in": "query",
"name": "segments_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "segments_count__lt",
"in": "query",
"name": "segments_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "segments_count__lte",
"in": "query",
"name": "segments_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "sent_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"queued",
"over_quota",
"sent",
"failed",
"received"
],
"type": "string"
}
},
{
"description": "state__in",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"sms"
]
},
"post": {
"operationId": "sms_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"sms"
]
}
},
"/sms/{id}/": {
"delete": {
"operationId": "sms_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this sms.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"sms"
]
},
"get": {
"operationId": "sms_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this sms.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"sms"
]
},
"patch": {
"operationId": "sms_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this sms.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"sms"
]
},
"put": {
"operationId": "sms_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this sms.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"sms"
]
}
},
"/sms/{id}/resend/": {
"post": {
"operationId": "sms_resend_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this sms.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"sms"
]
}
},
"/task_address_features/": {
"get": {
"operationId": "task_address_features_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee",
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "category",
"in": "query",
"name": "category",
"required": false,
"schema": {
"enum": [
"assignment",
"pick_up",
"drop_off",
"warehouse"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "owner",
"in": "query",
"name": "owner",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_address_features"
]
}
},
"/task_address_features/{id}/": {
"get": {
"operationId": "task_address_features_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_address_features"
]
}
},
"/task_commands/": {
"get": {
"operationId": "task_commands_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "accepted_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "action",
"in": "query",
"name": "action",
"required": false,
"schema": {
"enum": [
"update",
"reassign",
"assign",
"accept",
"unaccept",
"reject",
"unassign",
"transit",
"activate",
"complete",
"fail",
"cancel",
"assignee_near",
"assignee_away"
],
"type": "string"
}
},
{
"description": "assignee",
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "rejected_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"pending",
"accepted",
"rejected"
],
"type": "string"
}
},
{
"description": "task",
"in": "query",
"name": "task",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "task__account",
"in": "query",
"name": "task__account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "time",
"in": "query",
"name": "time",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_commands"
]
},
"post": {
"operationId": "task_commands_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_commands"
]
}
},
"/task_commands/{id}/": {
"get": {
"operationId": "task_commands_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task command.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_commands"
]
},
"put": {
"operationId": "task_commands_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task command.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_commands"
]
}
},
"/task_event_tracks/": {
"get": {
"operationId": "task_event_tracks_list",
"parameters": [
{
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "assignee__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "event",
"in": "query",
"name": "event",
"required": false,
"schema": {
"enum": [
"create",
"assign",
"unassign",
"reject",
"accept",
"unaccept",
"transit",
"activate",
"complete",
"fail",
"cancel",
"assignee_near",
"assignee_away",
"updated"
],
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "from_state",
"in": "query",
"name": "from_state",
"required": false,
"schema": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled",
"away",
"near"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "task",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "task__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "to_state",
"in": "query",
"name": "to_state",
"required": false,
"schema": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled",
"away",
"near"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "user",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "user__in",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_event_tracks"
]
}
},
"/task_event_tracks/{id}/": {
"get": {
"operationId": "task_event_tracks_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task event.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_event_tracks"
]
}
},
"/task_events/": {
"get": {
"description": "Mixin which allows the override of the filename being\npassed back to the user when the spreadsheet is downloaded.",
"operationId": "task_events_list",
"parameters": [
{
"description": "assignee",
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "event",
"in": "query",
"name": "event",
"required": false,
"schema": {
"enum": [
"create",
"assign",
"unassign",
"reject",
"accept",
"unaccept",
"transit",
"activate",
"complete",
"fail",
"cancel",
"assignee_near",
"assignee_away",
"updated"
],
"type": "string"
}
},
{
"description": "event__in",
"in": "query",
"name": "event__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "field",
"in": "query",
"name": "field",
"required": false,
"schema": {
"enum": [
"",
"state",
"assignee_proximity"
],
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "from_state",
"in": "query",
"name": "from_state",
"required": false,
"schema": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled",
"away",
"near"
],
"type": "string"
}
},
{
"description": "from_state__in",
"in": "query",
"name": "from_state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "task",
"in": "query",
"name": "task",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "task__account",
"in": "query",
"name": "task__account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "to_state",
"in": "query",
"name": "to_state",
"required": false,
"schema": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled",
"away",
"near"
],
"type": "string"
}
},
{
"description": "to_state__in",
"in": "query",
"name": "to_state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_events"
]
}
},
"/task_events/{id}/": {
"get": {
"description": "Mixin which allows the override of the filename being\npassed back to the user when the spreadsheet is downloaded.",
"operationId": "task_events_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task event.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_events"
]
}
},
"/task_exports/": {
"get": {
"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.\nAlso metafields can be added to the response. For this just add them as fields, using structure `metafields__{metafield.namespace}:{metafield.key}`. \n\nWhen 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",
"operationId": "task_exports_list",
"parameters": [
{
"in": "query",
"name": "account",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "account__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number",
"in": "query",
"name": "address__apartment_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__icontains",
"in": "query",
"name": "address__apartment_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__in",
"in": "query",
"name": "address__apartment_number__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__iregex",
"in": "query",
"name": "address__apartment_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__istartswith",
"in": "query",
"name": "address__apartment_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__search",
"in": "query",
"name": "address__apartment_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city",
"in": "query",
"name": "address__city",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__icontains",
"in": "query",
"name": "address__city__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__in",
"in": "query",
"name": "address__city__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__iregex",
"in": "query",
"name": "address__city__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__istartswith",
"in": "query",
"name": "address__city__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__search",
"in": "query",
"name": "address__city__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country",
"in": "query",
"name": "address__country",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__icontains",
"in": "query",
"name": "address__country__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__in",
"in": "query",
"name": "address__country__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__iregex",
"in": "query",
"name": "address__country__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__istartswith",
"in": "query",
"name": "address__country__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__search",
"in": "query",
"name": "address__country__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code",
"in": "query",
"name": "address__country_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__icontains",
"in": "query",
"name": "address__country_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__in",
"in": "query",
"name": "address__country_code__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__iregex",
"in": "query",
"name": "address__country_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__istartswith",
"in": "query",
"name": "address__country_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__search",
"in": "query",
"name": "address__country_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address",
"in": "query",
"name": "address__formatted_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__icontains",
"in": "query",
"name": "address__formatted_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__in",
"in": "query",
"name": "address__formatted_address__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__iregex",
"in": "query",
"name": "address__formatted_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__istartswith",
"in": "query",
"name": "address__formatted_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__search",
"in": "query",
"name": "address__formatted_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "address__google_place_id",
"in": "query",
"name": "address__google_place_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__icontains",
"in": "query",
"name": "address__google_place_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__in",
"in": "query",
"name": "address__google_place_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__iregex",
"in": "query",
"name": "address__google_place_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__istartswith",
"in": "query",
"name": "address__google_place_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__search",
"in": "query",
"name": "address__google_place_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number",
"in": "query",
"name": "address__house_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__icontains",
"in": "query",
"name": "address__house_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__in",
"in": "query",
"name": "address__house_number__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__iregex",
"in": "query",
"name": "address__house_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__istartswith",
"in": "query",
"name": "address__house_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__search",
"in": "query",
"name": "address__house_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest",
"in": "query",
"name": "address__point_of_interest",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__icontains",
"in": "query",
"name": "address__point_of_interest__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__in",
"in": "query",
"name": "address__point_of_interest__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__iregex",
"in": "query",
"name": "address__point_of_interest__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__istartswith",
"in": "query",
"name": "address__point_of_interest__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__search",
"in": "query",
"name": "address__point_of_interest__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code",
"in": "query",
"name": "address__postal_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__icontains",
"in": "query",
"name": "address__postal_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__in",
"in": "query",
"name": "address__postal_code__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__iregex",
"in": "query",
"name": "address__postal_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__istartswith",
"in": "query",
"name": "address__postal_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__search",
"in": "query",
"name": "address__postal_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address",
"in": "query",
"name": "address__raw_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__icontains",
"in": "query",
"name": "address__raw_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__in",
"in": "query",
"name": "address__raw_address__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__iregex",
"in": "query",
"name": "address__raw_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__istartswith",
"in": "query",
"name": "address__raw_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__search",
"in": "query",
"name": "address__raw_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state",
"in": "query",
"name": "address__state",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__icontains",
"in": "query",
"name": "address__state__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__in",
"in": "query",
"name": "address__state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__iregex",
"in": "query",
"name": "address__state__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__istartswith",
"in": "query",
"name": "address__state__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__search",
"in": "query",
"name": "address__state__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street",
"in": "query",
"name": "address__street",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__icontains",
"in": "query",
"name": "address__street__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__in",
"in": "query",
"name": "address__street__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__iregex",
"in": "query",
"name": "address__street__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__istartswith",
"in": "query",
"name": "address__street__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__search",
"in": "query",
"name": "address__street__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "address_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id",
"in": "query",
"name": "address_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id__in",
"in": "query",
"name": "address_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id__isnull",
"in": "query",
"name": "address_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "assignee__email",
"in": "query",
"name": "assignee__email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__icontains",
"in": "query",
"name": "assignee__email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__iregex",
"in": "query",
"name": "assignee__email__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__isnull",
"in": "query",
"name": "assignee__email__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__istartswith",
"in": "query",
"name": "assignee__email__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__search",
"in": "query",
"name": "assignee__email__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name",
"in": "query",
"name": "assignee__first_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__icontains",
"in": "query",
"name": "assignee__first_name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__iregex",
"in": "query",
"name": "assignee__first_name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__isnull",
"in": "query",
"name": "assignee__first_name__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__istartswith",
"in": "query",
"name": "assignee__first_name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__search",
"in": "query",
"name": "assignee__first_name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "assignee__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name",
"in": "query",
"name": "assignee__last_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__icontains",
"in": "query",
"name": "assignee__last_name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__iregex",
"in": "query",
"name": "assignee__last_name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__isnull",
"in": "query",
"name": "assignee__last_name__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__istartswith",
"in": "query",
"name": "assignee__last_name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__search",
"in": "query",
"name": "assignee__last_name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone",
"in": "query",
"name": "assignee__phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__icontains",
"in": "query",
"name": "assignee__phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__iregex",
"in": "query",
"name": "assignee__phone__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__isnull",
"in": "query",
"name": "assignee__phone__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__istartswith",
"in": "query",
"name": "assignee__phone__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__search",
"in": "query",
"name": "assignee__phone__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id",
"in": "query",
"name": "assignee_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id__in",
"in": "query",
"name": "assignee_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id__isnull",
"in": "query",
"name": "assignee_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_proximity",
"in": "query",
"name": "assignee_proximity",
"required": false,
"schema": {
"enum": [
"away",
"near"
],
"type": "string"
}
},
{
"description": "assignee_proximity__in",
"in": "query",
"name": "assignee_proximity__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "barcodes__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "category",
"in": "query",
"name": "category",
"required": false,
"schema": {
"enum": [
"assignment",
"pick_up",
"drop_off",
"warehouse"
],
"type": "string"
}
},
{
"description": "category__in",
"in": "query",
"name": "category__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "contact__company__icontains",
"in": "query",
"name": "contact__company__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__in",
"in": "query",
"name": "contact__company__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__iregex",
"in": "query",
"name": "contact__company__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__istartswith",
"in": "query",
"name": "contact__company__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__search",
"in": "query",
"name": "contact__company__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email",
"in": "query",
"name": "contact__email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__icontains",
"in": "query",
"name": "contact__email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__in",
"in": "query",
"name": "contact__email__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__iregex",
"in": "query",
"name": "contact__email__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__istartswith",
"in": "query",
"name": "contact__email__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__search",
"in": "query",
"name": "contact__email__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__emails__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name",
"in": "query",
"name": "contact__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__icontains",
"in": "query",
"name": "contact__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__in",
"in": "query",
"name": "contact__name__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__iregex",
"in": "query",
"name": "contact__name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__istartswith",
"in": "query",
"name": "contact__name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__search",
"in": "query",
"name": "contact__name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes",
"in": "query",
"name": "contact__notes",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__icontains",
"in": "query",
"name": "contact__notes__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__in",
"in": "query",
"name": "contact__notes__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__iregex",
"in": "query",
"name": "contact__notes__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__istartswith",
"in": "query",
"name": "contact__notes__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__search",
"in": "query",
"name": "contact__notes__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone",
"in": "query",
"name": "contact__phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__icontains",
"in": "query",
"name": "contact__phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__in",
"in": "query",
"name": "contact__phone__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__iregex",
"in": "query",
"name": "contact__phone__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__istartswith",
"in": "query",
"name": "contact__phone__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__search",
"in": "query",
"name": "contact__phone__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__phones__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "contact_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id",
"in": "query",
"name": "contact_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id__in",
"in": "query",
"name": "contact_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id__isnull",
"in": "query",
"name": "contact_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "created_by",
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "created_by__in",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "created_by__isnull",
"in": "query",
"name": "created_by__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__icontains",
"in": "query",
"name": "description__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__iregex",
"in": "query",
"name": "description__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__istartswith",
"in": "query",
"name": "description__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__search",
"in": "query",
"name": "description__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration",
"in": "query",
"name": "duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__gt",
"in": "query",
"name": "duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__gte",
"in": "query",
"name": "duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__lt",
"in": "query",
"name": "duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__lte",
"in": "query",
"name": "duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id",
"in": "query",
"name": "external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__icontains",
"in": "query",
"name": "external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__in",
"in": "query",
"name": "external_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__iregex",
"in": "query",
"name": "external_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__isnull",
"in": "query",
"name": "external_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__istartswith",
"in": "query",
"name": "external_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__search",
"in": "query",
"name": "external_id__search",
"required": false,
"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": {
"summary": "Returns fields name, external_id, created_at and metafields__namespace:key in the same order",
"value": "name,external_id,created_at,metafields__namespace:key"
}
},
"in": "query",
"name": "fields",
"schema": {
"type": "string"
}
},
{
"description": "Selects response method. xlsx returns Excel file",
"in": "query",
"name": "format",
"schema": {
"default": "json",
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "id__in",
"in": "query",
"name": "id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_optimal",
"in": "query",
"name": "is_optimal",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_optimal__isnull",
"in": "query",
"name": "is_optimal__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance",
"in": "query",
"name": "metadata__accepted_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__gt",
"in": "query",
"name": "metadata__accepted_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__gte",
"in": "query",
"name": "metadata__accepted_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__lt",
"in": "query",
"name": "metadata__accepted_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__lte",
"in": "query",
"name": "metadata__accepted_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration",
"in": "query",
"name": "metadata__accepted_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__gt",
"in": "query",
"name": "metadata__accepted_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__gte",
"in": "query",
"name": "metadata__accepted_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__lt",
"in": "query",
"name": "metadata__accepted_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__lte",
"in": "query",
"name": "metadata__accepted_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance",
"in": "query",
"name": "metadata__active_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__gt",
"in": "query",
"name": "metadata__active_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__gte",
"in": "query",
"name": "metadata__active_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__lt",
"in": "query",
"name": "metadata__active_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__lte",
"in": "query",
"name": "metadata__active_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration",
"in": "query",
"name": "metadata__active_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__gt",
"in": "query",
"name": "metadata__active_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__gte",
"in": "query",
"name": "metadata__active_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__lt",
"in": "query",
"name": "metadata__active_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__lte",
"in": "query",
"name": "metadata__active_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance",
"in": "query",
"name": "metadata__assigned_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__gt",
"in": "query",
"name": "metadata__assigned_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__gte",
"in": "query",
"name": "metadata__assigned_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__lt",
"in": "query",
"name": "metadata__assigned_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__lte",
"in": "query",
"name": "metadata__assigned_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration",
"in": "query",
"name": "metadata__assigned_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__gt",
"in": "query",
"name": "metadata__assigned_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__gte",
"in": "query",
"name": "metadata__assigned_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__lt",
"in": "query",
"name": "metadata__assigned_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__lte",
"in": "query",
"name": "metadata__assigned_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance",
"in": "query",
"name": "metadata__cancelled_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__gt",
"in": "query",
"name": "metadata__cancelled_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__gte",
"in": "query",
"name": "metadata__cancelled_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__lt",
"in": "query",
"name": "metadata__cancelled_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__lte",
"in": "query",
"name": "metadata__cancelled_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration",
"in": "query",
"name": "metadata__cancelled_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__gt",
"in": "query",
"name": "metadata__cancelled_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__gte",
"in": "query",
"name": "metadata__cancelled_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__lt",
"in": "query",
"name": "metadata__cancelled_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__lte",
"in": "query",
"name": "metadata__cancelled_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance",
"in": "query",
"name": "metadata__completed_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__gt",
"in": "query",
"name": "metadata__completed_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__gte",
"in": "query",
"name": "metadata__completed_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__lt",
"in": "query",
"name": "metadata__completed_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__lte",
"in": "query",
"name": "metadata__completed_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration",
"in": "query",
"name": "metadata__completed_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__gt",
"in": "query",
"name": "metadata__completed_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__gte",
"in": "query",
"name": "metadata__completed_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__lt",
"in": "query",
"name": "metadata__completed_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__lte",
"in": "query",
"name": "metadata__completed_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count",
"in": "query",
"name": "metadata__documents_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__gt",
"in": "query",
"name": "metadata__documents_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__gte",
"in": "query",
"name": "metadata__documents_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__lt",
"in": "query",
"name": "metadata__documents_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__lte",
"in": "query",
"name": "metadata__documents_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count",
"in": "query",
"name": "metadata__events_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__gt",
"in": "query",
"name": "metadata__events_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__gte",
"in": "query",
"name": "metadata__events_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__lt",
"in": "query",
"name": "metadata__events_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__lte",
"in": "query",
"name": "metadata__events_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance",
"in": "query",
"name": "metadata__failed_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__gt",
"in": "query",
"name": "metadata__failed_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__gte",
"in": "query",
"name": "metadata__failed_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__lt",
"in": "query",
"name": "metadata__failed_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__lte",
"in": "query",
"name": "metadata__failed_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration",
"in": "query",
"name": "metadata__failed_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__gt",
"in": "query",
"name": "metadata__failed_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__gte",
"in": "query",
"name": "metadata__failed_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__lt",
"in": "query",
"name": "metadata__failed_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__lte",
"in": "query",
"name": "metadata__failed_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count",
"in": "query",
"name": "metadata__forms_completed_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__gt",
"in": "query",
"name": "metadata__forms_completed_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__gte",
"in": "query",
"name": "metadata__forms_completed_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__lt",
"in": "query",
"name": "metadata__forms_completed_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__lte",
"in": "query",
"name": "metadata__forms_completed_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count",
"in": "query",
"name": "metadata__forms_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__gt",
"in": "query",
"name": "metadata__forms_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__gte",
"in": "query",
"name": "metadata__forms_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__lt",
"in": "query",
"name": "metadata__forms_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__lte",
"in": "query",
"name": "metadata__forms_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "metadata__signatures_count",
"in": "query",
"name": "metadata__signatures_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__gt",
"in": "query",
"name": "metadata__signatures_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__gte",
"in": "query",
"name": "metadata__signatures_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__lt",
"in": "query",
"name": "metadata__signatures_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__lte",
"in": "query",
"name": "metadata__signatures_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count",
"in": "query",
"name": "metadata__task_event_notes_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__gt",
"in": "query",
"name": "metadata__task_event_notes_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__gte",
"in": "query",
"name": "metadata__task_event_notes_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__lt",
"in": "query",
"name": "metadata__task_event_notes_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__lte",
"in": "query",
"name": "metadata__task_event_notes_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance",
"in": "query",
"name": "metadata__transit_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__gt",
"in": "query",
"name": "metadata__transit_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__gte",
"in": "query",
"name": "metadata__transit_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__lt",
"in": "query",
"name": "metadata__transit_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__lte",
"in": "query",
"name": "metadata__transit_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration",
"in": "query",
"name": "metadata__transit_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__gt",
"in": "query",
"name": "metadata__transit_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__gte",
"in": "query",
"name": "metadata__transit_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__lt",
"in": "query",
"name": "metadata__transit_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__lte",
"in": "query",
"name": "metadata__transit_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance",
"in": "query",
"name": "metadata__unassigned_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__gt",
"in": "query",
"name": "metadata__unassigned_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__gte",
"in": "query",
"name": "metadata__unassigned_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__lt",
"in": "query",
"name": "metadata__unassigned_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__lte",
"in": "query",
"name": "metadata__unassigned_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration",
"in": "query",
"name": "metadata__unassigned_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__gt",
"in": "query",
"name": "metadata__unassigned_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__gte",
"in": "query",
"name": "metadata__unassigned_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__lt",
"in": "query",
"name": "metadata__unassigned_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__lte",
"in": "query",
"name": "metadata__unassigned_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "metafields__namespace:key",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "order",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "order__auto_assign",
"in": "query",
"name": "order__auto_assign",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "order__created_by",
"in": "query",
"name": "order__created_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__created_by__in",
"in": "query",
"name": "order__created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__created_by__isnull",
"in": "query",
"name": "order__created_by__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id",
"in": "query",
"name": "order__external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__icontains",
"in": "query",
"name": "order__external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__in",
"in": "query",
"name": "order__external_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__iregex",
"in": "query",
"name": "order__external_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__isnull",
"in": "query",
"name": "order__external_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__istartswith",
"in": "query",
"name": "order__external_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__search",
"in": "query",
"name": "order__external_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "order__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "order__orderer",
"required": false,
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
},
{
"description": "order__reference",
"in": "query",
"name": "order__reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__icontains",
"in": "query",
"name": "order__reference__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__in",
"in": "query",
"name": "order__reference__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__iregex",
"in": "query",
"name": "order__reference__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__istartswith",
"in": "query",
"name": "order__reference__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__search",
"in": "query",
"name": "order__reference__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id",
"in": "query",
"name": "order_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id__in",
"in": "query",
"name": "order_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id__isnull",
"in": "query",
"name": "order_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderer",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "orderer__id",
"in": "query",
"name": "orderer__id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__id__in",
"in": "query",
"name": "orderer__id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__id__isnull",
"in": "query",
"name": "orderer__id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "orderer__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__name",
"in": "query",
"name": "orderer__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__name__icontains",
"in": "query",
"name": "orderer__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id",
"in": "query",
"name": "orderer_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id__in",
"in": "query",
"name": "orderer_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id__isnull",
"in": "query",
"name": "orderer_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id",
"in": "query",
"name": "owner_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id__in",
"in": "query",
"name": "owner_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id__isnull",
"in": "query",
"name": "owner_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "A page number within the paginated result set.",
"in": "query",
"name": "page",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated UUID values supported",
"example": "1329af07-9fb7-4b2d-925c-3f3e5f64d812,6728e86b-64e4-49af-a1f4-6720f884a3c3",
"in": "query",
"name": "previous_assignees__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated UUID values supported",
"example": "1329af07-9fb7-4b2d-925c-3f3e5f64d812,6728e86b-64e4-49af-a1f4-6720f884a3c3",
"in": "query",
"name": "previous_assignees__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "previous_assignees__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated UUID values supported",
"example": "1329af07-9fb7-4b2d-925c-3f3e5f64d812,6728e86b-64e4-49af-a1f4-6720f884a3c3",
"in": "query",
"name": "previous_assignees__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority",
"in": "query",
"name": "priority",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__gt",
"in": "query",
"name": "priority__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__gte",
"in": "query",
"name": "priority__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__in",
"in": "query",
"name": "priority__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__lt",
"in": "query",
"name": "priority__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__lte",
"in": "query",
"name": "priority__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "receiver",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "receiver__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id",
"in": "query",
"name": "receiver_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id__in",
"in": "query",
"name": "receiver_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id__isnull",
"in": "query",
"name": "receiver_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference",
"in": "query",
"name": "reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__icontains",
"in": "query",
"name": "reference__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__in",
"in": "query",
"name": "reference__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__iregex",
"in": "query",
"name": "reference__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__istartswith",
"in": "query",
"name": "reference__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__search",
"in": "query",
"name": "reference__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "route",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "route__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id",
"in": "query",
"name": "route_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id__in",
"in": "query",
"name": "route_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id__isnull",
"in": "query",
"name": "route_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "size__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled"
],
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "task_import",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "task_import__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id",
"in": "query",
"name": "unassignee_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id__in",
"in": "query",
"name": "unassignee_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id__isnull",
"in": "query",
"name": "unassignee_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"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,
"in": "query",
"name": "updated_at_delay_latest",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_exports"
]
}
},
"/task_forms/": {
"get": {
"operationId": "task_forms_list",
"parameters": [
{
"description": "completed",
"in": "query",
"name": "completed",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "task",
"in": "query",
"name": "task",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_forms"
]
},
"post": {
"operationId": "task_forms_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_forms"
]
}
},
"/task_forms/{id}/": {
"delete": {
"operationId": "task_forms_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task form.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_forms"
]
},
"get": {
"operationId": "task_forms_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task form.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_forms"
]
},
"patch": {
"operationId": "task_forms_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task form.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_forms"
]
},
"put": {
"operationId": "task_forms_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task form.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_forms"
]
}
},
"/task_import/": {
"get": {
"operationId": "task_import_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "started_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"pending",
"started",
"completed",
"failed"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_import"
]
},
"post": {
"operationId": "task_import_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_import"
]
}
},
"/task_import/{id}/": {
"get": {
"operationId": "task_import_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this tasks background import.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_import"
]
}
},
"/task_import_mapping/": {
"get": {
"operationId": "task_import_mapping_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "field_names__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "field_names__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "field_names__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "field_names__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_import_mapping"
]
},
"post": {
"operationId": "task_import_mapping_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_import_mapping"
]
}
},
"/task_import_mapping/{id}/": {
"get": {
"operationId": "task_import_mapping_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this mapping.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_import_mapping"
]
}
},
"/task_metadatas/": {
"get": {
"operationId": "task_metadatas_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "task",
"in": "query",
"name": "task",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_metadatas"
]
}
},
"/task_metadatas/{id}/": {
"get": {
"operationId": "task_metadatas_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task metadata.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"task_metadatas"
]
}
},
"/tasks/": {
"get": {
"operationId": "tasks_list",
"parameters": [
{
"in": "query",
"name": "account",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "account__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number",
"in": "query",
"name": "address__apartment_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__icontains",
"in": "query",
"name": "address__apartment_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__in",
"in": "query",
"name": "address__apartment_number__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__iregex",
"in": "query",
"name": "address__apartment_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__istartswith",
"in": "query",
"name": "address__apartment_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__apartment_number__search",
"in": "query",
"name": "address__apartment_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city",
"in": "query",
"name": "address__city",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__icontains",
"in": "query",
"name": "address__city__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__in",
"in": "query",
"name": "address__city__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__iregex",
"in": "query",
"name": "address__city__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__istartswith",
"in": "query",
"name": "address__city__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__city__search",
"in": "query",
"name": "address__city__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country",
"in": "query",
"name": "address__country",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__icontains",
"in": "query",
"name": "address__country__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__in",
"in": "query",
"name": "address__country__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__iregex",
"in": "query",
"name": "address__country__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__istartswith",
"in": "query",
"name": "address__country__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country__search",
"in": "query",
"name": "address__country__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code",
"in": "query",
"name": "address__country_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__icontains",
"in": "query",
"name": "address__country_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__in",
"in": "query",
"name": "address__country_code__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__iregex",
"in": "query",
"name": "address__country_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__istartswith",
"in": "query",
"name": "address__country_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__country_code__search",
"in": "query",
"name": "address__country_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address",
"in": "query",
"name": "address__formatted_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__icontains",
"in": "query",
"name": "address__formatted_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__in",
"in": "query",
"name": "address__formatted_address__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__iregex",
"in": "query",
"name": "address__formatted_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__istartswith",
"in": "query",
"name": "address__formatted_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__formatted_address__search",
"in": "query",
"name": "address__formatted_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocode_failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "address__geocoded_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "address__google_place_id",
"in": "query",
"name": "address__google_place_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__icontains",
"in": "query",
"name": "address__google_place_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__in",
"in": "query",
"name": "address__google_place_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__iregex",
"in": "query",
"name": "address__google_place_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__istartswith",
"in": "query",
"name": "address__google_place_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__google_place_id__search",
"in": "query",
"name": "address__google_place_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number",
"in": "query",
"name": "address__house_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__icontains",
"in": "query",
"name": "address__house_number__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__in",
"in": "query",
"name": "address__house_number__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__iregex",
"in": "query",
"name": "address__house_number__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__istartswith",
"in": "query",
"name": "address__house_number__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__house_number__search",
"in": "query",
"name": "address__house_number__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest",
"in": "query",
"name": "address__point_of_interest",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__icontains",
"in": "query",
"name": "address__point_of_interest__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__in",
"in": "query",
"name": "address__point_of_interest__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__iregex",
"in": "query",
"name": "address__point_of_interest__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__istartswith",
"in": "query",
"name": "address__point_of_interest__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__point_of_interest__search",
"in": "query",
"name": "address__point_of_interest__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code",
"in": "query",
"name": "address__postal_code",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__icontains",
"in": "query",
"name": "address__postal_code__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__in",
"in": "query",
"name": "address__postal_code__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__iregex",
"in": "query",
"name": "address__postal_code__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__istartswith",
"in": "query",
"name": "address__postal_code__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__postal_code__search",
"in": "query",
"name": "address__postal_code__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address",
"in": "query",
"name": "address__raw_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__icontains",
"in": "query",
"name": "address__raw_address__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__in",
"in": "query",
"name": "address__raw_address__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__iregex",
"in": "query",
"name": "address__raw_address__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__istartswith",
"in": "query",
"name": "address__raw_address__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__raw_address__search",
"in": "query",
"name": "address__raw_address__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state",
"in": "query",
"name": "address__state",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__icontains",
"in": "query",
"name": "address__state__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__in",
"in": "query",
"name": "address__state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__iregex",
"in": "query",
"name": "address__state__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__istartswith",
"in": "query",
"name": "address__state__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__state__search",
"in": "query",
"name": "address__state__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street",
"in": "query",
"name": "address__street",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__icontains",
"in": "query",
"name": "address__street__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__in",
"in": "query",
"name": "address__street__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__iregex",
"in": "query",
"name": "address__street__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__istartswith",
"in": "query",
"name": "address__street__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address__street__search",
"in": "query",
"name": "address__street__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "address_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id",
"in": "query",
"name": "address_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id__in",
"in": "query",
"name": "address_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "address_id__isnull",
"in": "query",
"name": "address_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "assignee",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "assignee__email",
"in": "query",
"name": "assignee__email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__icontains",
"in": "query",
"name": "assignee__email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__iregex",
"in": "query",
"name": "assignee__email__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__isnull",
"in": "query",
"name": "assignee__email__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__istartswith",
"in": "query",
"name": "assignee__email__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__email__search",
"in": "query",
"name": "assignee__email__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name",
"in": "query",
"name": "assignee__first_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__icontains",
"in": "query",
"name": "assignee__first_name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__iregex",
"in": "query",
"name": "assignee__first_name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__isnull",
"in": "query",
"name": "assignee__first_name__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__istartswith",
"in": "query",
"name": "assignee__first_name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__first_name__search",
"in": "query",
"name": "assignee__first_name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "assignee__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name",
"in": "query",
"name": "assignee__last_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__icontains",
"in": "query",
"name": "assignee__last_name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__iregex",
"in": "query",
"name": "assignee__last_name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__isnull",
"in": "query",
"name": "assignee__last_name__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__istartswith",
"in": "query",
"name": "assignee__last_name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__last_name__search",
"in": "query",
"name": "assignee__last_name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone",
"in": "query",
"name": "assignee__phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__icontains",
"in": "query",
"name": "assignee__phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__iregex",
"in": "query",
"name": "assignee__phone__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__isnull",
"in": "query",
"name": "assignee__phone__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__istartswith",
"in": "query",
"name": "assignee__phone__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee__phone__search",
"in": "query",
"name": "assignee__phone__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id",
"in": "query",
"name": "assignee_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id__in",
"in": "query",
"name": "assignee_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_id__isnull",
"in": "query",
"name": "assignee_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "assignee_proximity",
"in": "query",
"name": "assignee_proximity",
"required": false,
"schema": {
"enum": [
"away",
"near"
],
"type": "string"
}
},
{
"description": "assignee_proximity__in",
"in": "query",
"name": "assignee_proximity__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "barcodes__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "barcodes__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "cancelled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "category",
"in": "query",
"name": "category",
"required": false,
"schema": {
"enum": [
"assignment",
"pick_up",
"drop_off",
"warehouse"
],
"type": "string"
}
},
{
"description": "category__in",
"in": "query",
"name": "category__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_after__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "complete_before__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "contact__company__icontains",
"in": "query",
"name": "contact__company__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__in",
"in": "query",
"name": "contact__company__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__iregex",
"in": "query",
"name": "contact__company__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__istartswith",
"in": "query",
"name": "contact__company__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__company__search",
"in": "query",
"name": "contact__company__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email",
"in": "query",
"name": "contact__email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__icontains",
"in": "query",
"name": "contact__email__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__in",
"in": "query",
"name": "contact__email__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__iregex",
"in": "query",
"name": "contact__email__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__istartswith",
"in": "query",
"name": "contact__email__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__email__search",
"in": "query",
"name": "contact__email__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__emails__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated emails supported",
"example": "example1@mail.ee,example2@mail.ee",
"in": "query",
"name": "contact__emails__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name",
"in": "query",
"name": "contact__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__icontains",
"in": "query",
"name": "contact__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__in",
"in": "query",
"name": "contact__name__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__iregex",
"in": "query",
"name": "contact__name__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__istartswith",
"in": "query",
"name": "contact__name__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__name__search",
"in": "query",
"name": "contact__name__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes",
"in": "query",
"name": "contact__notes",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__icontains",
"in": "query",
"name": "contact__notes__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__in",
"in": "query",
"name": "contact__notes__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__iregex",
"in": "query",
"name": "contact__notes__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__istartswith",
"in": "query",
"name": "contact__notes__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__notes__search",
"in": "query",
"name": "contact__notes__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone",
"in": "query",
"name": "contact__phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__icontains",
"in": "query",
"name": "contact__phone__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__in",
"in": "query",
"name": "contact__phone__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__iregex",
"in": "query",
"name": "contact__phone__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__istartswith",
"in": "query",
"name": "contact__phone__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact__phone__search",
"in": "query",
"name": "contact__phone__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "contact__phones__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"example": "abc,def",
"in": "query",
"name": "contact__phones__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "contact_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id",
"in": "query",
"name": "contact_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id__in",
"in": "query",
"name": "contact_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "contact_id__isnull",
"in": "query",
"name": "contact_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "created_by",
"in": "query",
"name": "created_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "created_by__in",
"in": "query",
"name": "created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "created_by__isnull",
"in": "query",
"name": "created_by__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "description",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__icontains",
"in": "query",
"name": "description__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__iregex",
"in": "query",
"name": "description__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__istartswith",
"in": "query",
"name": "description__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "description__search",
"in": "query",
"name": "description__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration",
"in": "query",
"name": "duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__gt",
"in": "query",
"name": "duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__gte",
"in": "query",
"name": "duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__lt",
"in": "query",
"name": "duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "duration__lte",
"in": "query",
"name": "duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id",
"in": "query",
"name": "external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__icontains",
"in": "query",
"name": "external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__in",
"in": "query",
"name": "external_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__iregex",
"in": "query",
"name": "external_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__isnull",
"in": "query",
"name": "external_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__istartswith",
"in": "query",
"name": "external_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "external_id__search",
"in": "query",
"name": "external_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "id",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "id__in",
"in": "query",
"name": "id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_optimal",
"in": "query",
"name": "is_optimal",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "is_optimal__isnull",
"in": "query",
"name": "is_optimal__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance",
"in": "query",
"name": "metadata__accepted_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__gt",
"in": "query",
"name": "metadata__accepted_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__gte",
"in": "query",
"name": "metadata__accepted_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__lt",
"in": "query",
"name": "metadata__accepted_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_distance__lte",
"in": "query",
"name": "metadata__accepted_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration",
"in": "query",
"name": "metadata__accepted_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__gt",
"in": "query",
"name": "metadata__accepted_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__gte",
"in": "query",
"name": "metadata__accepted_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__lt",
"in": "query",
"name": "metadata__accepted_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__accepted_duration__lte",
"in": "query",
"name": "metadata__accepted_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance",
"in": "query",
"name": "metadata__active_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__gt",
"in": "query",
"name": "metadata__active_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__gte",
"in": "query",
"name": "metadata__active_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__lt",
"in": "query",
"name": "metadata__active_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_distance__lte",
"in": "query",
"name": "metadata__active_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration",
"in": "query",
"name": "metadata__active_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__gt",
"in": "query",
"name": "metadata__active_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__gte",
"in": "query",
"name": "metadata__active_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__lt",
"in": "query",
"name": "metadata__active_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__active_duration__lte",
"in": "query",
"name": "metadata__active_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance",
"in": "query",
"name": "metadata__assigned_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__gt",
"in": "query",
"name": "metadata__assigned_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__gte",
"in": "query",
"name": "metadata__assigned_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__lt",
"in": "query",
"name": "metadata__assigned_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_distance__lte",
"in": "query",
"name": "metadata__assigned_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration",
"in": "query",
"name": "metadata__assigned_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__gt",
"in": "query",
"name": "metadata__assigned_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__gte",
"in": "query",
"name": "metadata__assigned_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__lt",
"in": "query",
"name": "metadata__assigned_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__assigned_duration__lte",
"in": "query",
"name": "metadata__assigned_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance",
"in": "query",
"name": "metadata__cancelled_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__gt",
"in": "query",
"name": "metadata__cancelled_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__gte",
"in": "query",
"name": "metadata__cancelled_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__lt",
"in": "query",
"name": "metadata__cancelled_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_distance__lte",
"in": "query",
"name": "metadata__cancelled_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration",
"in": "query",
"name": "metadata__cancelled_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__gt",
"in": "query",
"name": "metadata__cancelled_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__gte",
"in": "query",
"name": "metadata__cancelled_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__lt",
"in": "query",
"name": "metadata__cancelled_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__cancelled_duration__lte",
"in": "query",
"name": "metadata__cancelled_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance",
"in": "query",
"name": "metadata__completed_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__gt",
"in": "query",
"name": "metadata__completed_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__gte",
"in": "query",
"name": "metadata__completed_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__lt",
"in": "query",
"name": "metadata__completed_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_distance__lte",
"in": "query",
"name": "metadata__completed_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration",
"in": "query",
"name": "metadata__completed_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__gt",
"in": "query",
"name": "metadata__completed_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__gte",
"in": "query",
"name": "metadata__completed_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__lt",
"in": "query",
"name": "metadata__completed_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__completed_duration__lte",
"in": "query",
"name": "metadata__completed_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count",
"in": "query",
"name": "metadata__documents_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__gt",
"in": "query",
"name": "metadata__documents_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__gte",
"in": "query",
"name": "metadata__documents_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__lt",
"in": "query",
"name": "metadata__documents_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__documents_count__lte",
"in": "query",
"name": "metadata__documents_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count",
"in": "query",
"name": "metadata__events_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__gt",
"in": "query",
"name": "metadata__events_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__gte",
"in": "query",
"name": "metadata__events_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__lt",
"in": "query",
"name": "metadata__events_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__events_count__lte",
"in": "query",
"name": "metadata__events_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance",
"in": "query",
"name": "metadata__failed_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__gt",
"in": "query",
"name": "metadata__failed_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__gte",
"in": "query",
"name": "metadata__failed_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__lt",
"in": "query",
"name": "metadata__failed_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_distance__lte",
"in": "query",
"name": "metadata__failed_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration",
"in": "query",
"name": "metadata__failed_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__gt",
"in": "query",
"name": "metadata__failed_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__gte",
"in": "query",
"name": "metadata__failed_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__lt",
"in": "query",
"name": "metadata__failed_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__failed_duration__lte",
"in": "query",
"name": "metadata__failed_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count",
"in": "query",
"name": "metadata__forms_completed_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__gt",
"in": "query",
"name": "metadata__forms_completed_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__gte",
"in": "query",
"name": "metadata__forms_completed_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__lt",
"in": "query",
"name": "metadata__forms_completed_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_completed_count__lte",
"in": "query",
"name": "metadata__forms_completed_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count",
"in": "query",
"name": "metadata__forms_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__gt",
"in": "query",
"name": "metadata__forms_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__gte",
"in": "query",
"name": "metadata__forms_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__lt",
"in": "query",
"name": "metadata__forms_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__forms_count__lte",
"in": "query",
"name": "metadata__forms_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_accepted_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_active_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_assigned_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_cancelled_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_completed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_failed_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_transit_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "metadata__last_unassigned_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "metadata__signatures_count",
"in": "query",
"name": "metadata__signatures_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__gt",
"in": "query",
"name": "metadata__signatures_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__gte",
"in": "query",
"name": "metadata__signatures_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__lt",
"in": "query",
"name": "metadata__signatures_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__signatures_count__lte",
"in": "query",
"name": "metadata__signatures_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count",
"in": "query",
"name": "metadata__task_event_notes_count",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__gt",
"in": "query",
"name": "metadata__task_event_notes_count__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__gte",
"in": "query",
"name": "metadata__task_event_notes_count__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__lt",
"in": "query",
"name": "metadata__task_event_notes_count__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__task_event_notes_count__lte",
"in": "query",
"name": "metadata__task_event_notes_count__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance",
"in": "query",
"name": "metadata__transit_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__gt",
"in": "query",
"name": "metadata__transit_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__gte",
"in": "query",
"name": "metadata__transit_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__lt",
"in": "query",
"name": "metadata__transit_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_distance__lte",
"in": "query",
"name": "metadata__transit_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration",
"in": "query",
"name": "metadata__transit_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__gt",
"in": "query",
"name": "metadata__transit_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__gte",
"in": "query",
"name": "metadata__transit_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__lt",
"in": "query",
"name": "metadata__transit_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__transit_duration__lte",
"in": "query",
"name": "metadata__transit_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance",
"in": "query",
"name": "metadata__unassigned_distance",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__gt",
"in": "query",
"name": "metadata__unassigned_distance__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__gte",
"in": "query",
"name": "metadata__unassigned_distance__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__lt",
"in": "query",
"name": "metadata__unassigned_distance__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_distance__lte",
"in": "query",
"name": "metadata__unassigned_distance__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration",
"in": "query",
"name": "metadata__unassigned_duration",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__gt",
"in": "query",
"name": "metadata__unassigned_duration__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__gte",
"in": "query",
"name": "metadata__unassigned_duration__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__lt",
"in": "query",
"name": "metadata__unassigned_duration__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "metadata__unassigned_duration__lte",
"in": "query",
"name": "metadata__unassigned_duration__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "metafields__namespace:key",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "order",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "order__auto_assign",
"in": "query",
"name": "order__auto_assign",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "order__created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "order__created_by",
"in": "query",
"name": "order__created_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__created_by__in",
"in": "query",
"name": "order__created_by__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__created_by__isnull",
"in": "query",
"name": "order__created_by__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id",
"in": "query",
"name": "order__external_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__icontains",
"in": "query",
"name": "order__external_id__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__in",
"in": "query",
"name": "order__external_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__iregex",
"in": "query",
"name": "order__external_id__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__isnull",
"in": "query",
"name": "order__external_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__istartswith",
"in": "query",
"name": "order__external_id__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__external_id__search",
"in": "query",
"name": "order__external_id__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "order__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Django ORM lookups can be used. Metafield `is_searchable` must be True.",
"in": "query",
"name": "order__orderer",
"required": false,
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
},
{
"description": "order__reference",
"in": "query",
"name": "order__reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__icontains",
"in": "query",
"name": "order__reference__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__in",
"in": "query",
"name": "order__reference__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__iregex",
"in": "query",
"name": "order__reference__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__istartswith",
"in": "query",
"name": "order__reference__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order__reference__search",
"in": "query",
"name": "order__reference__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id",
"in": "query",
"name": "order_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id__in",
"in": "query",
"name": "order_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "order_id__isnull",
"in": "query",
"name": "order_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderer",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "orderer__id",
"in": "query",
"name": "orderer__id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__id__in",
"in": "query",
"name": "orderer__id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__id__isnull",
"in": "query",
"name": "orderer__id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "orderer__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__name",
"in": "query",
"name": "orderer__name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer__name__icontains",
"in": "query",
"name": "orderer__name__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id",
"in": "query",
"name": "orderer_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id__in",
"in": "query",
"name": "orderer_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "orderer_id__isnull",
"in": "query",
"name": "orderer_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id",
"in": "query",
"name": "owner_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id__in",
"in": "query",
"name": "owner_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "owner_id__isnull",
"in": "query",
"name": "owner_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "position__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated UUID values supported",
"example": "a302e48a-bd04-4d36-b13e-38a77ec6701f,6cc0231a-c6bf-44c5-928f-82130830447c",
"in": "query",
"name": "previous_assignees__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated UUID values supported",
"example": "a302e48a-bd04-4d36-b13e-38a77ec6701f,6cc0231a-c6bf-44c5-928f-82130830447c",
"in": "query",
"name": "previous_assignees__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "previous_assignees__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated UUID values supported",
"example": "a302e48a-bd04-4d36-b13e-38a77ec6701f,6cc0231a-c6bf-44c5-928f-82130830447c",
"in": "query",
"name": "previous_assignees__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority",
"in": "query",
"name": "priority",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__gt",
"in": "query",
"name": "priority__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__gte",
"in": "query",
"name": "priority__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__in",
"in": "query",
"name": "priority__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__lt",
"in": "query",
"name": "priority__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "priority__lte",
"in": "query",
"name": "priority__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "receiver",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "receiver__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id",
"in": "query",
"name": "receiver_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id__in",
"in": "query",
"name": "receiver_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "receiver_id__isnull",
"in": "query",
"name": "receiver_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference",
"in": "query",
"name": "reference",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__icontains",
"in": "query",
"name": "reference__icontains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__in",
"in": "query",
"name": "reference__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__iregex",
"in": "query",
"name": "reference__iregex",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__istartswith",
"in": "query",
"name": "reference__istartswith",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "reference__search",
"in": "query",
"name": "reference__search",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "route",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "route__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id",
"in": "query",
"name": "route_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id__in",
"in": "query",
"name": "route_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "route_id__isnull",
"in": "query",
"name": "route_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "scheduled_time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__contained_by",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where filter_value in field values. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where the array is null",
"in": "query",
"name": "size__isnull",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated integer values supported",
"example": "11,23",
"in": "query",
"name": "size__overlap",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled"
],
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "state__not_in_or_isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "task_import",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "task_import__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id",
"in": "query",
"name": "unassignee_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id__in",
"in": "query",
"name": "unassignee_id__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "unassignee_id__isnull",
"in": "query",
"name": "unassignee_id__isnull",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"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,
"in": "query",
"name": "updated_at_delay_latest",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
},
"post": {
"operationId": "tasks_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskSerializerV2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskSerializerV2"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/reorder/": {
"post": {
"operationId": "tasks_reorder_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskListReorderRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskListReorderRequest"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/reposition/": {
"post": {
"operationId": "tasks_reposition_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskSerializerV2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskSerializerV2"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/": {
"get": {
"operationId": "tasks_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
},
"patch": {
"operationId": "tasks_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTaskSerializerV2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PatchedTaskSerializerV2"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
},
"put": {
"operationId": "tasks_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskSerializerV2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskSerializerV2"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/accept/": {
"post": {
"operationId": "tasks_accept_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/account_change/": {
"post": {
"operationId": "tasks_account_change_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAccountChange"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAccountChange"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/activate/": {
"post": {
"operationId": "tasks_activate_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/assign/": {
"post": {
"operationId": "tasks_assign_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAssign"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAssign"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/cancel/": {
"post": {
"operationId": "tasks_cancel_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/complete/": {
"post": {
"operationId": "tasks_complete_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/documents/": {
"get": {
"operationId": "tasks_documents_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/events/": {
"get": {
"operationId": "tasks_events_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/fail/": {
"post": {
"operationId": "tasks_fail_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/reject/": {
"post": {
"operationId": "tasks_reject_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/signatures/": {
"get": {
"operationId": "tasks_signatures_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/transit/": {
"post": {
"operationId": "tasks_transit_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/unaccept/": {
"post": {
"operationId": "tasks_unaccept_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/tasks/{id}/unassign/": {
"post": {
"operationId": "tasks_unassign_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this task.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "example1@mail.ee,example2@mail.ee"
}
},
"in": "query",
"name": "order__orderer__emails__overlap",
"schema": {
"type": "string"
}
},
{
"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"
}
},
{
"description": "Filter the returned list where all target array values contained in filter values. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contained_by",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where all filter_values are present. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__contains",
"schema": {
"type": "string"
}
},
{
"description": "Filter the returned list where at least one filter value in target array. Comma separated values supported",
"examples": {
"Example": {
"summary": "example",
"value": "+3725012345,5022333"
}
},
"in": "query",
"name": "order__orderer__phones__overlap",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TaskAction"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"tasks"
]
}
},
"/time_location_features/": {
"get": {
"operationId": "time_location_features_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"unknown",
"stopped",
"moving"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_location_features"
]
},
"post": {
"operationId": "time_location_features_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_location_features"
]
}
},
"/time_location_features/{id}/": {
"delete": {
"operationId": "time_location_features_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this time location.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_location_features"
]
},
"get": {
"operationId": "time_location_features_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this time location.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_location_features"
]
},
"patch": {
"operationId": "time_location_features_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this time location.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_location_features"
]
},
"put": {
"operationId": "time_location_features_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this time location.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_location_features"
]
}
},
"/time_locations/": {
"get": {
"operationId": "time_locations_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"unknown",
"stopped",
"moving"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_locations"
]
},
"post": {
"operationId": "time_locations_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_locations"
]
}
},
"/time_locations/{id}/": {
"get": {
"operationId": "time_locations_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this time location.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"time_locations"
]
}
},
"/trackers/": {
"get": {
"operationId": "trackers_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"trackers"
]
},
"post": {
"operationId": "trackers_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"trackers"
]
}
},
"/trackers/{id}/": {
"get": {
"operationId": "trackers_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this tracker.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"trackers"
]
},
"patch": {
"operationId": "trackers_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this tracker.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"trackers"
]
},
"put": {
"operationId": "trackers_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this tracker.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"trackers"
]
}
},
"/trackers/{id}/public/": {
"get": {
"operationId": "trackers_public_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this tracker.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"trackers"
]
}
},
"/users/": {
"get": {
"operationId": "users_list",
"parameters": [
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
},
"post": {
"operationId": "users_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticatedUserCreate"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AuthenticatedUserCreate"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
}
},
"/users/{id}/": {
"delete": {
"operationId": "users_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
},
"get": {
"operationId": "users_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
},
"patch": {
"operationId": "users_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedAuthenticatedUserUpdate"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PatchedAuthenticatedUserUpdate"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
},
"put": {
"operationId": "users_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthenticatedUserUpdate"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AuthenticatedUserUpdate"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
}
},
"/users/{id}/activate/": {
"post": {
"operationId": "users_activate_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserActivation"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/UserActivation"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
}
},
"/users/{id}/on_duty/": {
"delete": {
"operationId": "users_on_duty_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
},
"get": {
"operationId": "users_on_duty_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
},
"put": {
"operationId": "users_on_duty_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xml"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnDuty"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OnDuty"
}
}
},
"required": true
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users"
]
}
},
"/users_on_duty_log/": {
"get": {
"operationId": "users_on_duty_log_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "account_role",
"in": "query",
"name": "account_role",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "mode",
"in": "query",
"name": "mode",
"required": false,
"schema": {
"enum": [
"online",
"offline"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "status",
"in": "query",
"name": "status",
"required": false,
"schema": {
"enum": [
"on_duty",
"off_duty"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users_on_duty_log"
]
},
"post": {
"operationId": "users_on_duty_log_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users_on_duty_log"
]
}
},
"/users_on_duty_log/{id}/": {
"get": {
"operationId": "users_on_duty_log_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"users_on_duty_log"
]
}
},
"/webhooks/": {
"get": {
"operationId": "webhooks_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "document_events",
"in": "query",
"name": "document_events",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "review_events",
"in": "query",
"name": "review_events",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "A search term.",
"in": "query",
"name": "search",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "signature_events",
"in": "query",
"name": "signature_events",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"inactive",
"active",
"disabled"
],
"type": "string"
}
},
{
"description": "task_events",
"in": "query",
"name": "task_events",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "version",
"in": "query",
"name": "version",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"webhooks"
]
},
"post": {
"operationId": "webhooks_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"webhooks"
]
}
},
"/webhooks/{id}/": {
"delete": {
"operationId": "webhooks_destroy",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No response body"
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"webhooks"
]
},
"get": {
"operationId": "webhooks_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"webhooks"
]
},
"patch": {
"operationId": "webhooks_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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"
}
}
}
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"webhooks"
]
},
"put": {
"operationId": "webhooks_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"webhooks"
]
}
},
"/webhooks/{id}/active/": {
"post": {
"operationId": "webhooks_active_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"webhooks"
]
}
},
"/webhooks/{id}/inactive/": {
"post": {
"operationId": "webhooks_inactive_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"webhooks"
]
}
},
"/worker_features/": {
"get": {
"operationId": "worker_features_list",
"parameters": [
{
"in": "query",
"name": "account",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "account__in",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "state",
"in": "query",
"name": "state",
"required": false,
"schema": {
"enum": [
"unknown",
"stopped",
"moving"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "user",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "comma separated value",
"in": "query",
"name": "user__in",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"worker_features"
]
}
},
"/worker_features/{user_id}/": {
"get": {
"operationId": "worker_features_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"in": "path",
"name": "user_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"worker_features"
]
}
},
"/worker_tracks/": {
"get": {
"operationId": "worker_tracks_list",
"parameters": [
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "end_time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "start_time__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "updated_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json; version=2.4.13": {
"schema": {
"items": {
"$ref": "#/components/schemas/WorkerTrack"
},
"type": "array"
}
},
"application/xlsx; version=2.4.13": {
"schema": {
"items": {
"$ref": "#/components/schemas/WorkerTrack"
},
"type": "array"
}
}
},
"description": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"worker_tracks"
]
}
},
"/working_state/": {
"get": {
"operationId": "working_state_list",
"parameters": [
{
"description": "account",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "account_role",
"in": "query",
"name": "account_role",
"required": false,
"schema": {
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "created_at__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "The pagination cursor value.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "mode",
"in": "query",
"name": "mode",
"required": false,
"schema": {
"enum": [
"online",
"offline"
],
"type": "string"
}
},
{
"description": "Which field to use when ordering the results.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "status",
"in": "query",
"name": "status",
"required": false,
"schema": {
"enum": [
"on_duty",
"off_duty"
],
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__date",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__date_or_isnull",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__gt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__gt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__gte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__gte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__lt",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__lt_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__lte",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"example": "2022-11-04T11:19:24+00:00",
"in": "query",
"name": "timestamp__lte_or_isnull",
"required": false,
"schema": {
"format": "datetime",
"type": "string"
}
},
{
"description": "user",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"working_state"
]
},
"post": {
"operationId": "working_state_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
}
],
"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
},
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"working_state"
]
}
},
"/working_state/{id}/": {
"get": {
"operationId": "working_state_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
}
},
{
"description": "A UUID string identifying this user.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"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": ""
}
},
"security": [
{
"tokenAuth": []
}
],
"tags": [
"working_state"
]
}
}
},
"components": {
"schemas": {
"Account": {
"properties": {
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"assignee_proximity_radius": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"auto_assign_max_distance": {
"description": "How far can a task be auto assigned to a worker in meters?",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"title": "Maximum distance from task",
"type": "integer"
},
"auto_assign_max_tasks": {
"description": "How many tasks can be auto assigned to a worker?",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"title": "Maximum tasks per worker",
"type": "integer"
},
"auto_assign_optimize": {
"description": "Check the optimizer results before assignment?",
"title": "Optimize auto assignments",
"type": "boolean"
},
"auto_assign_orders": {
"type": "boolean"
},
"auto_assign_rotate": {
"default": "4 10:55:34.12",
"description": "Time after non-accepted task assignees will be rotated. Leave empty in case the orders should not be rotated",
"nullable": true,
"title": "Rotate assignee",
"type": "object"
},
"auto_assign_time_before": {
"nullable": true,
"type": "string"
},
"billing_address": {
"maxLength": 200,
"type": "string"
},
"billing_company": {
"maxLength": 100,
"type": "string"
},
"billing_country": {
"maxLength": 100,
"type": "string"
},
"billing_email": {
"format": "email",
"maxLength": 254,
"title": "Billing email address",
"type": "string"
},
"billing_method": {
"allOf": [
{
"$ref": "#/components/schemas/AccountBillingMethodEnum"
}
],
"readOnly": true
},
"billing_name": {
"maxLength": 100,
"type": "string"
},
"billing_phone": {
"maxLength": 20,
"type": "string"
},
"billing_vatin": {
"maxLength": 20,
"type": "string"
},
"calendar_task_template": {
"readOnly": true,
"type": "string"
},
"country_code": {
"oneOf": [
{
"$ref": "#/components/schemas/CountryCodeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"custom_integration_url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"dashboard_task_template": {
"readOnly": true,
"type": "string"
},
"dashboard_worker_limit": {
"readOnly": true,
"type": "integer"
},
"date_format": {
"$ref": "#/components/schemas/DateFormatEnum"
},
"distance_units": {
"$ref": "#/components/schemas/DistanceUnitsEnum"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"feature_address_autosuggest_provider": {
"$ref": "#/components/schemas/FeatureAddressAutosuggestProviderEnum"
},
"feature_app_task_search": {
"type": "boolean"
},
"feature_change_task_account": {
"readOnly": true,
"type": "boolean"
},
"feature_document_signing": {
"description": "Allow choosing documents to sign.",
"type": "boolean"
},
"feature_geocoding_country_code": {
"allOf": [
{
"$ref": "#/components/schemas/CountryCodeEnum"
}
],
"description": "Limit geocoding to the selected country.",
"readOnly": true
},
"feature_navigation_app_selection": {
"type": "boolean"
},
"feature_navigation_use_address": {
"type": "boolean"
},
"feature_show_tutorial": {
"type": "boolean"
},
"feature_show_unassigned_to_workers": {
"type": "boolean"
},
"feature_task_accept": {
"type": "boolean"
},
"feature_task_created_sound": {
"type": "boolean"
},
"feature_task_reject": {
"type": "boolean"
},
"feature_tracker_reviews_allowed": {
"type": "boolean"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"language": {
"allOf": [
{
"$ref": "#/components/schemas/LanguageEnum"
}
],
"title": "Prefered language"
},
"managers": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"notification_emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"optimization_objective": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectiveEnum"
}
],
"description": "Specify the default objective for your optimizationions",
"title": "Default optimization objective"
},
"optimize_after_create": {
"type": "boolean"
},
"owner": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"reference_autogenerate": {
"type": "boolean"
},
"reference_length": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"reference_offset": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"reference_prefix": {
"maxLength": 50,
"type": "string"
},
"registry_code": {
"maxLength": 20,
"type": "string"
},
"review_emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"route_end_address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"route_start_address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"slug": {
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/AccountStateEnum"
}
],
"readOnly": true
},
"stripe_customer_id": {
"readOnly": true,
"type": "string"
},
"stripe_payment_method_id": {
"description": "Reflects current default payment method. For reference only. ",
"readOnly": true,
"type": "string"
},
"task_duration": {
"default": "4 10:55:34.12",
"title": "Default task duration",
"type": "object"
},
"task_expiry_duration_from_complete_after": {
"default": "4 10:55:34.12",
"description": "HH:mm:ss",
"nullable": true,
"type": "object"
},
"task_expiry_duration_from_complete_before": {
"default": "4 10:55:34.12",
"description": "HH:mm:ss",
"nullable": true,
"type": "object"
},
"task_expiry_state": {
"$ref": "#/components/schemas/TaskExpiryStateEnum"
},
"time_format": {
"$ref": "#/components/schemas/TimeFormatEnum"
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"type": {
"oneOf": [
{
"$ref": "#/components/schemas/Type21dEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"vatin": {
"maxLength": 20,
"type": "string"
},
"website": {
"maxLength": 200,
"type": "string"
},
"workers": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"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"
],
"type": "object"
},
"AccountBillingMethodEnum": {
"enum": [
"braintree",
"free",
"invoice",
"stripe",
"trial"
],
"type": "string"
},
"AccountOwnerChange": {
"properties": {
"owner": {
"format": "uri",
"type": "string"
}
},
"required": [
"owner"
],
"type": "object"
},
"AccountRole": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"activated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"deleted_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"display_name": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"email": {
"format": "email",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"readOnly": true,
"type": "boolean"
},
"is_integration": {
"title": "Integration status",
"type": "boolean"
},
"is_manager": {
"title": "Manager status",
"type": "boolean"
},
"is_on_duty": {
"readOnly": true,
"type": "boolean"
},
"is_worker": {
"title": "Worker status",
"type": "boolean"
},
"last_time_location": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"route_end_address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"route_start_address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"show_unassigned": {
"title": "Show unassigned tasks",
"type": "boolean"
},
"signature_image": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/AccountRoleStateEnum"
}
],
"readOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"type": "string"
},
"vehicle_capacity": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"nullable": true,
"type": "array"
},
"vehicle_profile": {
"$ref": "#/components/schemas/VehicleProfileEnum"
},
"vehicle_registration_number": {
"maxLength": 32,
"title": "Vehicle registration",
"type": "string"
},
"vehicle_service_time_factor": {
"format": "decimal",
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,1})?$",
"type": "string"
},
"vehicle_speed_factor": {
"format": "decimal",
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,1})?$",
"type": "string"
}
},
"required": [
"account",
"activated_at",
"created_at",
"deleted_at",
"email",
"id",
"is_active",
"is_on_duty",
"last_time_location",
"signature_image",
"state",
"updated_at",
"url"
],
"type": "object"
},
"AccountRoleActivation": {
"properties": {
"token": {
"format": "uuid",
"type": "string",
"writeOnly": true
}
},
"required": [
"token"
],
"type": "object"
},
"AccountRoleStateEnum": {
"enum": [
"inactive",
"active",
"deleted"
],
"type": "string"
},
"AccountRoleToken": {
"properties": {
"token": {
"format": "uuid",
"readOnly": true,
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
},
"AccountStateEnum": {
"enum": [
"active",
"deactive",
"trial_expired",
"payment_overdue"
],
"type": "string"
},
"AccountStripePaymentMethodAttach": {
"properties": {
"set_default": {
"default": true,
"type": "boolean"
},
"stripe_customer_id": {
"maxLength": 255,
"type": "string"
},
"stripe_payment_method_id": {
"description": "Reflects current default payment method. For reference only. ",
"maxLength": 255,
"type": "string"
}
},
"required": [
"stripe_payment_method_id"
],
"type": "object"
},
"AccountStripePaymentMethodDetach": {
"properties": {
"stripe_payment_method_id": {
"description": "Reflects current default payment method. For reference only. ",
"maxLength": 255,
"type": "string"
}
},
"required": [
"stripe_payment_method_id"
],
"type": "object"
},
"AccountStripePaymentMethodGet": {
"properties": {
"payment_method_id": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"payment_method_id"
],
"type": "object"
},
"AccountStripePaymentMethodSetDefault": {
"properties": {
"stripe_payment_method_id": {
"description": "Reflects current default payment method. For reference only. ",
"maxLength": 255,
"type": "string"
}
},
"required": [
"stripe_payment_method_id"
],
"type": "object"
},
"AccountStripePaymentMethods": {
"properties": {
"default_payment_method_id": {
"maxLength": 100,
"readOnly": true,
"type": "string"
}
},
"required": [
"default_payment_method_id"
],
"type": "object"
},
"AccountStripeSetupAttemptGet": {
"properties": {
"setup_attempt_id": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"setup_attempt_id"
],
"type": "object"
},
"AccountStripeSetupIntentCreate": {
"properties": {
"payment_method_id": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"payment_method_id"
],
"type": "object"
},
"AccountStripeSetupIntentGet": {
"properties": {
"setup_intent_id": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"setup_intent_id"
],
"type": "object"
},
"AccountStripeSetupIntentsGet": {
"properties": {
"payment_method_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"AccountUser": {
"properties": {
"display_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"type": "string"
},
"first_name": {
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_on_duty": {
"readOnly": true,
"type": "boolean"
},
"last_name": {
"readOnly": true,
"type": "string"
},
"phone": {
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"display_name",
"email",
"first_name",
"id",
"is_on_duty",
"last_name",
"phone",
"url"
],
"type": "object"
},
"ActionEnum": {
"enum": [
"update",
"reassign",
"assign",
"accept",
"unaccept",
"reject",
"unassign",
"transit",
"activate",
"complete",
"fail",
"cancel",
"assignee_near",
"assignee_away"
],
"type": "string"
},
"Addon": {
"properties": {
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"price": {
"maxLength": 50,
"type": "string"
},
"short_description": {
"type": "string"
},
"unit": {
"maxLength": 50,
"type": "string"
}
},
"required": [
"description",
"icon",
"id",
"name",
"price",
"short_description",
"unit"
],
"type": "object"
},
"AppEnum": {
"enum": [
"android",
"ios",
"web"
],
"type": "string"
},
"AssigneeProximityEnum": {
"enum": [
"away",
"near"
],
"type": "string"
},
"AuthToken": {
"properties": {
"password": {
"type": "string",
"writeOnly": true
},
"token": {
"readOnly": true,
"type": "string"
},
"username": {
"type": "string",
"writeOnly": true
}
},
"required": [
"password",
"token",
"username"
],
"type": "object"
},
"AuthenticatedUserCreate": {
"properties": {
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"display_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"type": "string"
},
"first_name": {
"maxLength": 30,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"last_name": {
"maxLength": 30,
"type": "string"
},
"password": {
"type": "string",
"writeOnly": true
},
"phone": {
"maxLength": 128,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"display_name",
"email",
"id",
"url"
],
"type": "object"
},
"AuthenticatedUserUpdate": {
"properties": {
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"display_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"type": "string"
},
"first_name": {
"maxLength": 30,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"last_name": {
"maxLength": 30,
"type": "string"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"display_name",
"email",
"id",
"url"
],
"type": "object"
},
"BlankEnum": {
"enum": [
""
]
},
"BraintreeCustomer": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"braintree_id": {
"maxLength": 36,
"nullable": true,
"type": "string"
},
"company": {
"maxLength": 255,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"first_name": {
"maxLength": 255,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"last_name": {
"maxLength": 255,
"type": "string"
},
"payment_method_nonce": {
"maxLength": 250,
"nullable": true,
"type": "string"
},
"phone": {
"maxLength": 14,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"vat": {
"maxLength": 20,
"type": "string"
},
"website": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"account",
"created_at",
"id",
"updated_at",
"url"
],
"type": "object"
},
"BraintreeTransaction": {
"properties": {
"amount": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"currency": {
"maxLength": 3,
"type": "string"
},
"customer": {
"format": "uri",
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"invoice": {
"format": "uri",
"type": "string"
},
"response": {
"readOnly": true,
"type": "string"
},
"status": {
"maxLength": 24,
"type": "string"
},
"timestamp": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"type": {
"maxLength": 6,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount",
"created_at",
"customer",
"id",
"invoice",
"response",
"timestamp",
"updated_at",
"url"
],
"type": "object"
},
"Client": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"archived": {
"type": "boolean"
},
"contact_addresses": {
"items": {
"additionalProperties": {},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 200,
"type": "string"
},
"slug": {
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"contact_addresses",
"created_at",
"id",
"name",
"slug",
"updated_at",
"url"
],
"type": "object"
},
"ClientRole": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"client": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"description": "Designates whether this Client Role should be treated as active.",
"title": "Active",
"type": "boolean"
},
"is_manager": {
"title": "Manager status",
"type": "boolean"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"type": "string"
}
},
"required": [
"account",
"client",
"created_at",
"id",
"updated_at",
"url",
"user"
],
"type": "object"
},
"ConfigurationDefaults": {
"properties": {
"distance_units": {
"type": "string"
},
"task_duration": {
"default": "4 10:55:34.12",
"type": "object"
}
},
"required": [
"distance_units",
"task_duration"
],
"type": "object"
},
"ConfigurationNotification": {
"properties": {
"level": {
"$ref": "#/components/schemas/LevelEnum"
},
"message": {
"type": "string"
},
"open_in_new_window": {
"default": false,
"type": "boolean"
},
"persist": {
"default": false,
"type": "boolean"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"required": [
"level",
"message",
"url"
],
"type": "object"
},
"ConfigurationSerializerV2": {
"properties": {
"account": {
"allOf": [
{
"$ref": "#/components/schemas/Account"
}
],
"readOnly": true
},
"app": {
"allOf": [
{
"$ref": "#/components/schemas/AppEnum"
}
],
"readOnly": true
},
"auth": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"billing": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"defaults": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationDefaults"
}
],
"readOnly": true
},
"features": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"id": {
"readOnly": true,
"type": "string"
},
"is_client_role": {
"default": false,
"type": "boolean"
},
"is_staff": {
"default": false,
"type": "boolean"
},
"legacy_views": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"readOnly": true
},
"notifications": {
"items": {
"$ref": "#/components/schemas/ConfigurationNotification"
},
"readOnly": true,
"type": "array"
},
"permissions": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"settings": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationSettings"
}
],
"readOnly": true
},
"templates": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"tracking": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/ReadableUser"
}
],
"readOnly": true
},
"version": {
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"app",
"auth",
"billing",
"defaults",
"features",
"id",
"legacy_views",
"location",
"notifications",
"permissions",
"settings",
"templates",
"tracking",
"user",
"version"
],
"type": "object"
},
"ConfigurationSettings": {
"properties": {
"date_format": {
"type": "string"
},
"task_command_queue_limit": {
"default": "4 10:55:34.12",
"type": "object"
},
"time_format": {
"type": "string"
}
},
"required": [
"date_format",
"task_command_queue_limit",
"time_format"
],
"type": "object"
},
"ContactAddress": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"client": {
"format": "uri",
"type": "string"
},
"contact": {
"$ref": "#/components/schemas/NestedContact"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_orderer": {
"type": "boolean"
},
"is_receiver": {
"type": "boolean"
},
"source": {
"maxLength": 100,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"address",
"contact",
"created_at",
"id",
"updated_at",
"url"
],
"type": "object"
},
"ContactAddressBackgroundImport": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"celery_task_id": {
"readOnly": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"contact_addresses_created": {
"items": {
"format": "uri",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"contact_addresses_data": {
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array",
"writeOnly": true
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"errors": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"started_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/TasksBackgroundImportStateEnum"
}
],
"readOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"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"
],
"type": "object"
},
"ContactAddressExport": {
"properties": {
"account__name": {
"default": "",
"type": "string"
},
"address__apartment_number": {
"default": "",
"type": "string"
},
"address__city": {
"default": "",
"type": "string"
},
"address__country": {
"default": "",
"type": "string"
},
"address__country_code": {
"default": "",
"type": "string"
},
"address__formatted_address": {
"default": "",
"type": "string"
},
"address__google_place_id": {
"default": "",
"type": "string"
},
"address__house_number": {
"default": "",
"type": "string"
},
"address__location": {
"$ref": "#/components/schemas/Location"
},
"address__point_of_interest": {
"default": "",
"type": "string"
},
"address__postal_code": {
"default": "",
"type": "string"
},
"address__raw_address": {
"default": "",
"type": "string"
},
"address__state": {
"default": "",
"type": "string"
},
"address__street": {
"default": "",
"type": "string"
},
"contact__company": {
"default": "",
"type": "string"
},
"contact__emails": {
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"contact__name": {
"default": "",
"type": "string"
},
"contact__notes": {
"default": "",
"type": "string"
},
"contact__phones": {
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_orderer": {
"type": "boolean"
},
"is_receiver": {
"type": "boolean"
},
"source": {
"maxLength": 100,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"address__location",
"created_at",
"id",
"updated_at"
],
"type": "object"
},
"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": {
"properties": {
"assigned_task_counts": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"orders": {
"items": {
"$ref": "#/components/schemas/Order"
},
"type": "array"
},
"task_metadatas": {
"items": {
"$ref": "#/components/schemas/TaskMetadata"
},
"type": "array"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/LegacyTask"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"worker_features": {
"items": {
"$ref": "#/components/schemas/WorkerFeature"
},
"type": "array"
},
"workers": {
"items": {
"$ref": "#/components/schemas/AccountUser"
},
"type": "array"
}
},
"required": [
"assigned_task_counts",
"orders",
"task_metadatas",
"tasks",
"updated_at",
"worker_features",
"workers"
],
"type": "object"
},
"DateFormatEnum": {
"enum": [
"DD.MM.YYYY",
"YYYY-MM-DD",
"DD/MM/YYYY",
"MM/DD/YYYY"
],
"type": "string"
},
"Device": {
"properties": {
"battery_level": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"brand": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"build_number": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"device_country": {
"maxLength": 2,
"nullable": true,
"type": "string"
},
"device_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"device_locale": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"free_disk_storage": {
"format": "int64",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"nullable": true,
"type": "integer"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"ios_app_tracking_permission": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"is_charging": {
"nullable": true,
"type": "boolean"
},
"location_permission": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"manufacturer": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"model": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"motion_permission": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notification_permission": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"readable_version": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"system_name": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"system_version": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"timezone": {
"oneOf": [
{
"$ref": "#/components/schemas/TimezoneEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"type": "string"
},
"version": {
"maxLength": 100,
"nullable": true,
"type": "string"
}
},
"required": [
"created_at",
"id",
"url",
"user"
],
"type": "object"
},
"DistanceUnitsEnum": {
"enum": [
"kilometers",
"miles"
],
"type": "string"
},
"Document": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"file": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"file_name": {
"readOnly": true,
"type": "string"
},
"file_upload": {
"format": "uri",
"nullable": true,
"type": "string",
"writeOnly": true
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"mimetype": {
"readOnly": true,
"type": "string"
},
"order": {
"format": "uri",
"nullable": true,
"type": "string"
},
"source": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SourceEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"task": {
"format": "uri",
"nullable": true,
"type": "string"
},
"thumbnail": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"visible_to_client": {
"type": "boolean"
},
"visible_to_worker": {
"type": "boolean"
}
},
"required": [
"created_at",
"created_by",
"file",
"file_name",
"id",
"mimetype",
"thumbnail",
"updated_at",
"url"
],
"type": "object"
},
"DocumentDeleteAction": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"documents": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
}
},
"required": [
"account",
"documents"
],
"type": "object"
},
"Email": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"external_id": {
"maxLength": 34,
"type": "string"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"from_email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"message": {
"type": "string"
},
"notification": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"received_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"reply_to_email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"sender": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"sent_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/EmailStateEnum"
}
],
"readOnly": true
},
"subject": {
"maxLength": 250,
"type": "string"
},
"to_emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_at",
"failed_at",
"id",
"message",
"notification",
"received_at",
"sender",
"sent_at",
"state",
"subject",
"url"
],
"type": "object"
},
"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": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"export_model": {
"$ref": "#/components/schemas/ExportModelEnum"
},
"field_names": {
"items": {
"maxLength": 100,
"type": "string"
},
"nullable": true,
"type": "array"
},
"format": {
"$ref": "#/components/schemas/FormatEnum"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"link": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_at",
"export_model",
"format",
"id",
"link",
"updated_at",
"url"
],
"type": "object"
},
"ExportModelEnum": {
"enum": [
"tasks"
],
"type": "string"
},
"FeatureAddressAutosuggestProviderEnum": {
"enum": [
"google",
"heremaps",
"regio",
"janaseta"
],
"type": "string"
},
"FieldEnum": {
"enum": [
"state",
"assignee_proximity"
],
"type": "string"
},
"FormRule": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"edit_url": {
"format": "uri",
"maxLength": 200,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"maxLength": 50,
"type": "string"
},
"pdf_url": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"rules": {
"additionalProperties": {},
"type": "object"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"view_url": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
}
},
"required": [
"account",
"edit_url",
"id",
"name",
"rules",
"url"
],
"type": "object"
},
"FormatEnum": {
"enum": [
"json",
"xlsx"
],
"type": "string"
},
"ImportMapping": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"field_names": {
"items": {
"type": "string"
},
"type": "array",
"writeOnly": true
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"lines": {
"items": {
"$ref": "#/components/schemas/ImportMappingLine"
},
"type": "array"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_at",
"field_names",
"id",
"lines",
"url"
],
"type": "object"
},
"ImportMappingLine": {
"properties": {
"format": {
"maxLength": 200,
"nullable": true,
"type": "string"
},
"from_field": {
"maxLength": 100,
"type": "string"
},
"to_field": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"from_field"
],
"type": "object"
},
"IntegrationRequest": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 200,
"type": "string"
},
"notes": {
"type": "string"
},
"user": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"id",
"name",
"user"
],
"type": "object"
},
"Invoice": {
"properties": {
"account": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceAccount"
}
],
"readOnly": true
},
"billing_method": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceBillingMethodEnum"
}
],
"readOnly": true
},
"confirmed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"confirmed_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"currency": {
"readOnly": true,
"type": "string"
},
"due_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"items": {
"items": {
"$ref": "#/components/schemas/InvoiceItem"
},
"readOnly": true,
"type": "array"
},
"paid_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"period": {
"description": "Indicates what period the price was calculated for",
"items": {
"format": "date",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"pricing": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceStateEnum"
}
],
"readOnly": true
},
"total_no_vat": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"readOnly": true,
"type": "string"
},
"total_vat": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"readOnly": true,
"type": "string"
},
"total_with_vat": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"vat": {
"readOnly": true,
"type": "boolean"
}
},
"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"
],
"type": "object"
},
"InvoiceAccount": {
"properties": {
"billing_email": {
"format": "email",
"maxLength": 254,
"title": "Billing email address",
"type": "string"
},
"billing_reference": {
"maxLength": 20,
"type": "string"
},
"billing_vat": {
"type": "boolean"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"registry_code": {
"maxLength": 20,
"type": "string"
},
"slug": {
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true,
"type": "string"
},
"vatin": {
"maxLength": 20,
"type": "string"
}
},
"required": [
"id",
"name",
"slug"
],
"type": "object"
},
"InvoiceBillingMethodEnum": {
"enum": [
"braintree",
"invoice",
"stripe"
],
"type": "string"
},
"InvoiceItem": {
"properties": {
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"invoice": {
"format": "uri",
"type": "string"
},
"name": {
"maxLength": 200,
"type": "string"
},
"quantity": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,4})?$",
"type": "string"
},
"total": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"readOnly": true,
"type": "string"
},
"unit": {
"maxLength": 50,
"type": "string"
},
"unit_price": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"created_at",
"id",
"invoice",
"name",
"quantity",
"total",
"unit_price",
"updated_at"
],
"type": "object"
},
"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": {
"description": "Support depreciated fields phone and email\n\nwrite to new fields phones[0] and emails[0]",
"properties": {
"company": {
"maxLength": 200,
"type": "string"
},
"email": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"emails": {
"items": {
"maxLength": 100,
"type": "string"
},
"type": "array"
},
"name": {
"maxLength": 200,
"type": "string"
},
"notes": {
"type": "string"
},
"phone": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"phones": {
"items": {
"maxLength": 100,
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LegacyTask": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"actions": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"assignee_proximity": {
"allOf": [
{
"$ref": "#/components/schemas/AssigneeProximityEnum"
}
],
"readOnly": true
},
"auto_assign": {
"type": "boolean"
},
"cancelled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"category": {
"$ref": "#/components/schemas/TaskCategoryEnum"
},
"complete_after": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"complete_before": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"contact": {
"$ref": "#/components/schemas/LegacyNestedContact"
},
"counts": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"documents": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"events": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"forms": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"is_full_load": {
"type": "boolean"
},
"issues": {
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"metafields": {
"additionalProperties": {},
"type": "object"
},
"order": {
"format": "uri",
"nullable": true,
"type": "string"
},
"order_reference": {
"readOnly": true,
"type": "string"
},
"orderer": {
"format": "uri",
"nullable": true,
"type": "string"
},
"orderer_name": {
"readOnly": true,
"type": "string"
},
"position": {
"format": "double",
"maximum": 253402300799,
"minimum": 0,
"nullable": true,
"type": "number"
},
"priority": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"receiver": {
"format": "uri",
"nullable": true,
"type": "string"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"route": {
"format": "uri",
"nullable": true,
"type": "string"
},
"scheduled_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"signatures": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"size": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"nullable": true,
"type": "array"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskStateEnum"
}
],
"readOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"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"
],
"type": "object"
},
"LevelEnum": {
"enum": [
"danger",
"warning",
"success"
],
"type": "string"
},
"Location": {
"properties": {
"coordinates": {
"items": {
"format": "double",
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": {
"$ref": "#/components/schemas/LocationTypeEnum"
}
},
"required": [
"coordinates",
"type"
],
"type": "object"
},
"LocationTypeEnum": {
"enum": [
"Point"
],
"type": "string"
},
"Metafield": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"choices": {
"items": {
"maxLength": 100,
"type": "string"
},
"nullable": true,
"type": "array"
},
"choices_url": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"field_name": {
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_editable": {
"description": "Editable by manager",
"type": "boolean"
},
"is_editable_assignee": {
"description": "Editable by assignee",
"type": "boolean"
},
"is_persistent": {
"description": "Metadata, that will be copied to on recurrence.",
"type": "boolean"
},
"is_required": {
"type": "boolean"
},
"is_searchable": {
"type": "boolean"
},
"key": {
"maxLength": 20,
"pattern": "[a-z0-9]+$",
"type": "string"
},
"label": {
"maxLength": 40,
"type": "string"
},
"namespace": {
"default": "gsmtasks",
"maxLength": 20,
"pattern": "[a-z0-9]+$",
"type": "string"
},
"ordering": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"show_in_detail_view": {
"type": "boolean"
},
"show_in_list_view": {
"type": "boolean"
},
"show_in_mobile_app": {
"type": "boolean"
},
"show_in_pod": {
"title": "Show in proof of delivery",
"type": "boolean"
},
"show_when_task_type_assignment": {
"type": "boolean"
},
"show_when_task_type_drop_off": {
"type": "boolean"
},
"show_when_task_type_pick_up": {
"type": "boolean"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"value_type": {
"$ref": "#/components/schemas/ValueTypeEnum"
}
},
"required": [
"account",
"created_at",
"field_name",
"id",
"key",
"updated_at",
"url"
],
"type": "object"
},
"MethodEnum": {
"enum": [
"app",
"email",
"sms"
],
"type": "string"
},
"ModeEnum": {
"enum": [
"online",
"offline"
],
"type": "string"
},
"NestedAddress": {
"properties": {
"apartment_number": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"city": {
"maxLength": 100,
"type": "string"
},
"country": {
"maxLength": 100,
"type": "string"
},
"country_code": {
"maxLength": 2,
"type": "string"
},
"formatted_address": {
"maxLength": 250,
"type": "string"
},
"geocode_failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"geocoded_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"google_place_id": {
"maxLength": 250,
"type": "string"
},
"house_number": {
"maxLength": 100,
"type": "string"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"point_of_interest": {
"maxLength": 100,
"type": "string"
},
"postal_code": {
"maxLength": 100,
"type": "string"
},
"raw_address": {
"maxLength": 250,
"type": "string"
},
"state": {
"maxLength": 100,
"type": "string"
},
"street": {
"maxLength": 200,
"type": "string"
}
},
"required": [
"geocode_failed_at",
"geocoded_at"
],
"type": "object"
},
"NestedContact": {
"properties": {
"company": {
"maxLength": 200,
"type": "string"
},
"emails": {
"items": {
"maxLength": 100,
"type": "string"
},
"type": "array"
},
"name": {
"maxLength": 200,
"type": "string"
},
"notes": {
"type": "string"
},
"phones": {
"items": {
"maxLength": 100,
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Notification": {
"properties": {
"add_tracking_link": {
"type": "boolean"
},
"assignee_proximity": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AssigneeProximityEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"emails": {
"items": {
"format": "email",
"type": "string"
},
"nullable": true,
"type": "array"
},
"event": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EventEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"message": {
"type": "string"
},
"method": {
"allOf": [
{
"$ref": "#/components/schemas/MethodEnum"
}
],
"readOnly": true
},
"phones": {
"items": {
"maxLength": 128,
"type": "string"
},
"type": "array"
},
"recipient": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RecipientEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"sent_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"sms_count": {
"readOnly": true,
"type": "integer"
},
"state": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TaskStateEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"task": {
"format": "uri",
"type": "string"
},
"template": {
"format": "uri",
"nullable": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"via_app": {
"readOnly": true,
"type": "boolean"
},
"via_email": {
"readOnly": true,
"type": "boolean"
},
"via_sms": {
"readOnly": true,
"type": "boolean"
}
},
"required": [
"created_at",
"id",
"method",
"sms_count",
"task",
"updated_at",
"url",
"via_app",
"via_email",
"via_sms"
],
"type": "object"
},
"NotificationTemplate": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"email_reply_to": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"event": {
"oneOf": [
{
"$ref": "#/components/schemas/EventEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"type": "boolean"
},
"message": {
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phones": {
"items": {
"maxLength": 128,
"type": "string"
},
"type": "array"
},
"recipient": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RecipientEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"scheduled_time_change": {
"type": "boolean"
},
"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"
}
]
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"via_app": {
"type": "boolean"
},
"via_email": {
"type": "boolean"
},
"via_sms": {
"type": "boolean"
}
},
"required": [
"account",
"created_at",
"id",
"message",
"name",
"updated_at",
"url"
],
"type": "object"
},
"NullEnum": {
"enum": [
null
]
},
"ObjectiveEnum": {
"enum": [
"vehicles",
"transport_time",
"completion_time"
],
"type": "string"
},
"OnDuty": {
"properties": {
"account": {
"format": "uri",
"type": "string"
}
},
"required": [
"account"
],
"type": "object"
},
"Order": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"auto_assign": {
"type": "boolean"
},
"client": {
"format": "uri",
"nullable": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"tasks": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_at",
"created_by",
"tasks",
"updated_at",
"url"
],
"type": "object"
},
"OrderListScene": {
"properties": {
"assignees": {
"items": {
"$ref": "#/components/schemas/PublicUser"
},
"type": "array"
},
"clients": {
"items": {
"$ref": "#/components/schemas/Client"
},
"type": "array"
},
"orders": {
"items": {
"$ref": "#/components/schemas/Order"
},
"type": "array"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/LegacyTask"
},
"type": "array"
}
},
"required": [
"assignees",
"clients",
"orders",
"tasks"
],
"type": "object"
},
"OrderSerializerV2": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"auto_assign": {
"type": "boolean"
},
"client": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"documents": {
"items": {
"format": "uri",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"orderer": {
"$ref": "#/components/schemas/NestedContact"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"tasks": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"tasks_data": {
"items": {
"$ref": "#/components/schemas/TaskSerializerV2"
},
"type": "array",
"writeOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_at",
"created_by",
"documents",
"updated_at",
"url"
],
"type": "object"
},
"PaginatedAccountList": {
"items": {
"$ref": "#/components/schemas/Account"
},
"type": "array"
},
"PaginatedAccountRoleList": {
"items": {
"$ref": "#/components/schemas/AccountRole"
},
"type": "array"
},
"PaginatedAddonList": {
"items": {
"$ref": "#/components/schemas/Addon"
},
"type": "array"
},
"PaginatedBraintreeCustomerList": {
"items": {
"$ref": "#/components/schemas/BraintreeCustomer"
},
"type": "array"
},
"PaginatedBraintreeTransactionList": {
"items": {
"$ref": "#/components/schemas/BraintreeTransaction"
},
"type": "array"
},
"PaginatedClientList": {
"items": {
"$ref": "#/components/schemas/Client"
},
"type": "array"
},
"PaginatedClientRoleList": {
"items": {
"$ref": "#/components/schemas/ClientRole"
},
"type": "array"
},
"PaginatedConfigurationSerializerV2List": {
"items": {
"$ref": "#/components/schemas/ConfigurationSerializerV2"
},
"type": "array"
},
"PaginatedContactAddressBackgroundImportList": {
"items": {
"$ref": "#/components/schemas/ContactAddressBackgroundImport"
},
"type": "array"
},
"PaginatedContactAddressExportList": {
"items": {
"$ref": "#/components/schemas/ContactAddressExport"
},
"type": "array"
},
"PaginatedContactAddressList": {
"items": {
"$ref": "#/components/schemas/ContactAddress"
},
"type": "array"
},
"PaginatedDashboardSceneList": {
"items": {
"$ref": "#/components/schemas/DashboardScene"
},
"type": "array"
},
"PaginatedDeviceList": {
"items": {
"$ref": "#/components/schemas/Device"
},
"type": "array"
},
"PaginatedDocumentList": {
"items": {
"$ref": "#/components/schemas/Document"
},
"type": "array"
},
"PaginatedEmailList": {
"items": {
"$ref": "#/components/schemas/Email"
},
"type": "array"
},
"PaginatedExportList": {
"items": {
"$ref": "#/components/schemas/Export"
},
"type": "array"
},
"PaginatedFormRuleList": {
"items": {
"$ref": "#/components/schemas/FormRule"
},
"type": "array"
},
"PaginatedImportMappingList": {
"items": {
"$ref": "#/components/schemas/ImportMapping"
},
"type": "array"
},
"PaginatedInvoiceList": {
"items": {
"$ref": "#/components/schemas/Invoice"
},
"type": "array"
},
"PaginatedMetafieldList": {
"items": {
"$ref": "#/components/schemas/Metafield"
},
"type": "array"
},
"PaginatedNotificationList": {
"items": {
"$ref": "#/components/schemas/Notification"
},
"type": "array"
},
"PaginatedNotificationTemplateList": {
"items": {
"$ref": "#/components/schemas/NotificationTemplate"
},
"type": "array"
},
"PaginatedOrderListSceneList": {
"items": {
"$ref": "#/components/schemas/OrderListScene"
},
"type": "array"
},
"PaginatedOrderSerializerV2List": {
"items": {
"$ref": "#/components/schemas/OrderSerializerV2"
},
"type": "array"
},
"PaginatedPushNotificationList": {
"items": {
"$ref": "#/components/schemas/PushNotification"
},
"type": "array"
},
"PaginatedRecurrenceList": {
"items": {
"$ref": "#/components/schemas/Recurrence"
},
"type": "array"
},
"PaginatedRecurrenceListSceneList": {
"items": {
"$ref": "#/components/schemas/RecurrenceListScene"
},
"type": "array"
},
"PaginatedReviewList": {
"items": {
"$ref": "#/components/schemas/Review"
},
"type": "array"
},
"PaginatedRouteList": {
"items": {
"$ref": "#/components/schemas/Route"
},
"type": "array"
},
"PaginatedRouteOptimizationSerializerV2List": {
"items": {
"$ref": "#/components/schemas/RouteOptimizationSerializerV2"
},
"type": "array"
},
"PaginatedS3FileUploadList": {
"items": {
"$ref": "#/components/schemas/S3FileUpload"
},
"type": "array"
},
"PaginatedSMSList": {
"items": {
"$ref": "#/components/schemas/SMS"
},
"type": "array"
},
"PaginatedSignatureList": {
"items": {
"$ref": "#/components/schemas/Signature"
},
"type": "array"
},
"PaginatedStripePaymentList": {
"items": {
"$ref": "#/components/schemas/StripePayment"
},
"type": "array"
},
"PaginatedTaskAddressFeatureList": {
"items": {
"$ref": "#/components/schemas/TaskAddressFeature"
},
"type": "array"
},
"PaginatedTaskCommandList": {
"items": {
"$ref": "#/components/schemas/TaskCommand"
},
"type": "array"
},
"PaginatedTaskEventSerializerV2List": {
"items": {
"$ref": "#/components/schemas/TaskEventSerializerV2"
},
"type": "array"
},
"PaginatedTaskEventTrackList": {
"items": {
"$ref": "#/components/schemas/TaskEventTrack"
},
"type": "array"
},
"PaginatedTaskExportList": {
"items": {
"$ref": "#/components/schemas/TaskExport"
},
"type": "array"
},
"PaginatedTaskFormList": {
"items": {
"$ref": "#/components/schemas/TaskForm"
},
"type": "array"
},
"PaginatedTaskListSceneList": {
"items": {
"$ref": "#/components/schemas/TaskListScene"
},
"type": "array"
},
"PaginatedTaskMetadataList": {
"items": {
"$ref": "#/components/schemas/TaskMetadata"
},
"type": "array"
},
"PaginatedTaskSerializerV2List": {
"items": {
"$ref": "#/components/schemas/TaskSerializerV2"
},
"type": "array"
},
"PaginatedTasksBackgroundImportList": {
"items": {
"$ref": "#/components/schemas/TasksBackgroundImport"
},
"type": "array"
},
"PaginatedTimeLocationFeatureList": {
"items": {
"$ref": "#/components/schemas/TimeLocationFeature"
},
"type": "array"
},
"PaginatedTimeLocationList": {
"items": {
"$ref": "#/components/schemas/TimeLocation"
},
"type": "array"
},
"PaginatedTrackerList": {
"items": {
"$ref": "#/components/schemas/Tracker"
},
"type": "array"
},
"PaginatedUserList": {
"items": {
"$ref": "#/components/schemas/User"
},
"type": "array"
},
"PaginatedWebhookList": {
"items": {
"$ref": "#/components/schemas/Webhook"
},
"type": "array"
},
"PaginatedWorkerFeatureList": {
"items": {
"$ref": "#/components/schemas/WorkerFeature"
},
"type": "array"
},
"PaginatedWorkingStateList": {
"items": {
"$ref": "#/components/schemas/WorkingState"
},
"type": "array"
},
"PasswordChange": {
"properties": {
"new_password1": {
"type": "string"
},
"new_password2": {
"type": "string"
},
"old_password": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"old_password"
],
"type": "object"
},
"PasswordReset": {
"properties": {
"email": {
"format": "email",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"PasswordResetConfirm": {
"properties": {
"new_password1": {
"type": "string"
},
"new_password2": {
"type": "string"
},
"token": {
"type": "string"
},
"uidb64": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"token",
"uidb64"
],
"type": "object"
},
"PatchedAccount": {
"properties": {
"address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"assignee_proximity_radius": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"auto_assign_max_distance": {
"description": "How far can a task be auto assigned to a worker in meters?",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"title": "Maximum distance from task",
"type": "integer"
},
"auto_assign_max_tasks": {
"description": "How many tasks can be auto assigned to a worker?",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"title": "Maximum tasks per worker",
"type": "integer"
},
"auto_assign_optimize": {
"description": "Check the optimizer results before assignment?",
"title": "Optimize auto assignments",
"type": "boolean"
},
"auto_assign_orders": {
"type": "boolean"
},
"auto_assign_rotate": {
"default": "4 10:55:34.12",
"description": "Time after non-accepted task assignees will be rotated. Leave empty in case the orders should not be rotated",
"nullable": true,
"title": "Rotate assignee",
"type": "object"
},
"auto_assign_time_before": {
"nullable": true,
"type": "string"
},
"billing_address": {
"maxLength": 200,
"type": "string"
},
"billing_company": {
"maxLength": 100,
"type": "string"
},
"billing_country": {
"maxLength": 100,
"type": "string"
},
"billing_email": {
"format": "email",
"maxLength": 254,
"title": "Billing email address",
"type": "string"
},
"billing_method": {
"allOf": [
{
"$ref": "#/components/schemas/AccountBillingMethodEnum"
}
],
"readOnly": true
},
"billing_name": {
"maxLength": 100,
"type": "string"
},
"billing_phone": {
"maxLength": 20,
"type": "string"
},
"billing_vatin": {
"maxLength": 20,
"type": "string"
},
"calendar_task_template": {
"readOnly": true,
"type": "string"
},
"country_code": {
"oneOf": [
{
"$ref": "#/components/schemas/CountryCodeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"custom_integration_url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"dashboard_task_template": {
"readOnly": true,
"type": "string"
},
"dashboard_worker_limit": {
"readOnly": true,
"type": "integer"
},
"date_format": {
"$ref": "#/components/schemas/DateFormatEnum"
},
"distance_units": {
"$ref": "#/components/schemas/DistanceUnitsEnum"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"feature_address_autosuggest_provider": {
"$ref": "#/components/schemas/FeatureAddressAutosuggestProviderEnum"
},
"feature_app_task_search": {
"type": "boolean"
},
"feature_change_task_account": {
"readOnly": true,
"type": "boolean"
},
"feature_document_signing": {
"description": "Allow choosing documents to sign.",
"type": "boolean"
},
"feature_geocoding_country_code": {
"allOf": [
{
"$ref": "#/components/schemas/CountryCodeEnum"
}
],
"description": "Limit geocoding to the selected country.",
"readOnly": true
},
"feature_navigation_app_selection": {
"type": "boolean"
},
"feature_navigation_use_address": {
"type": "boolean"
},
"feature_show_tutorial": {
"type": "boolean"
},
"feature_show_unassigned_to_workers": {
"type": "boolean"
},
"feature_task_accept": {
"type": "boolean"
},
"feature_task_created_sound": {
"type": "boolean"
},
"feature_task_reject": {
"type": "boolean"
},
"feature_tracker_reviews_allowed": {
"type": "boolean"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"language": {
"allOf": [
{
"$ref": "#/components/schemas/LanguageEnum"
}
],
"title": "Prefered language"
},
"managers": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"notification_emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"optimization_objective": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectiveEnum"
}
],
"description": "Specify the default objective for your optimizationions",
"title": "Default optimization objective"
},
"optimize_after_create": {
"type": "boolean"
},
"owner": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"reference_autogenerate": {
"type": "boolean"
},
"reference_length": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"reference_offset": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"reference_prefix": {
"maxLength": 50,
"type": "string"
},
"registry_code": {
"maxLength": 20,
"type": "string"
},
"review_emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"route_end_address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"route_start_address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"slug": {
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/AccountStateEnum"
}
],
"readOnly": true
},
"stripe_customer_id": {
"readOnly": true,
"type": "string"
},
"stripe_payment_method_id": {
"description": "Reflects current default payment method. For reference only. ",
"readOnly": true,
"type": "string"
},
"task_duration": {
"default": "4 10:55:34.12",
"title": "Default task duration",
"type": "object"
},
"task_expiry_duration_from_complete_after": {
"default": "4 10:55:34.12",
"description": "HH:mm:ss",
"nullable": true,
"type": "object"
},
"task_expiry_duration_from_complete_before": {
"default": "4 10:55:34.12",
"description": "HH:mm:ss",
"nullable": true,
"type": "object"
},
"task_expiry_state": {
"$ref": "#/components/schemas/TaskExpiryStateEnum"
},
"time_format": {
"$ref": "#/components/schemas/TimeFormatEnum"
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"type": {
"oneOf": [
{
"$ref": "#/components/schemas/Type21dEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"vatin": {
"maxLength": 20,
"type": "string"
},
"website": {
"maxLength": 200,
"type": "string"
},
"workers": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedAccountRole": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"activated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"deleted_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"display_name": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"email": {
"format": "email",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"readOnly": true,
"type": "boolean"
},
"is_integration": {
"title": "Integration status",
"type": "boolean"
},
"is_manager": {
"title": "Manager status",
"type": "boolean"
},
"is_on_duty": {
"readOnly": true,
"type": "boolean"
},
"is_worker": {
"title": "Worker status",
"type": "boolean"
},
"last_time_location": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"route_end_address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"route_start_address": {
"allOf": [
{
"$ref": "#/components/schemas/NestedAddress"
}
],
"nullable": true
},
"show_unassigned": {
"title": "Show unassigned tasks",
"type": "boolean"
},
"signature_image": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/AccountRoleStateEnum"
}
],
"readOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"type": "string"
},
"vehicle_capacity": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"nullable": true,
"type": "array"
},
"vehicle_profile": {
"$ref": "#/components/schemas/VehicleProfileEnum"
},
"vehicle_registration_number": {
"maxLength": 32,
"title": "Vehicle registration",
"type": "string"
},
"vehicle_service_time_factor": {
"format": "decimal",
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,1})?$",
"type": "string"
},
"vehicle_speed_factor": {
"format": "decimal",
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,1})?$",
"type": "string"
}
},
"type": "object"
},
"PatchedAuthenticatedUserUpdate": {
"properties": {
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"display_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"type": "string"
},
"first_name": {
"maxLength": 30,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"last_name": {
"maxLength": 30,
"type": "string"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedBraintreeCustomer": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"braintree_id": {
"maxLength": 36,
"nullable": true,
"type": "string"
},
"company": {
"maxLength": 255,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"first_name": {
"maxLength": 255,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"last_name": {
"maxLength": 255,
"type": "string"
},
"payment_method_nonce": {
"maxLength": 250,
"nullable": true,
"type": "string"
},
"phone": {
"maxLength": 14,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"vat": {
"maxLength": 20,
"type": "string"
},
"website": {
"maxLength": 100,
"type": "string"
}
},
"type": "object"
},
"PatchedClient": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"archived": {
"type": "boolean"
},
"contact_addresses": {
"items": {
"additionalProperties": {},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 200,
"type": "string"
},
"slug": {
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedClientRole": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"client": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"description": "Designates whether this Client Role should be treated as active.",
"title": "Active",
"type": "boolean"
},
"is_manager": {
"title": "Manager status",
"type": "boolean"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"PatchedContactAddress": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"client": {
"format": "uri",
"type": "string"
},
"contact": {
"$ref": "#/components/schemas/NestedContact"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_orderer": {
"type": "boolean"
},
"is_receiver": {
"type": "boolean"
},
"source": {
"maxLength": 100,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedEmail": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"external_id": {
"maxLength": 34,
"type": "string"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"from_email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"message": {
"type": "string"
},
"notification": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"received_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"reply_to_email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"sender": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"sent_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/EmailStateEnum"
}
],
"readOnly": true
},
"subject": {
"maxLength": 250,
"type": "string"
},
"to_emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedExport": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"export_model": {
"$ref": "#/components/schemas/ExportModelEnum"
},
"field_names": {
"items": {
"maxLength": 100,
"type": "string"
},
"nullable": true,
"type": "array"
},
"format": {
"$ref": "#/components/schemas/FormatEnum"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"link": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedFormRule": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"edit_url": {
"format": "uri",
"maxLength": 200,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"maxLength": 50,
"type": "string"
},
"pdf_url": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"rules": {
"additionalProperties": {},
"type": "object"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"view_url": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"PatchedInvoice": {
"properties": {
"account": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceAccount"
}
],
"readOnly": true
},
"billing_method": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceBillingMethodEnum"
}
],
"readOnly": true
},
"confirmed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"confirmed_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"currency": {
"readOnly": true,
"type": "string"
},
"due_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"items": {
"items": {
"$ref": "#/components/schemas/InvoiceItem"
},
"readOnly": true,
"type": "array"
},
"paid_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"period": {
"description": "Indicates what period the price was calculated for",
"items": {
"format": "date",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"pricing": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceStateEnum"
}
],
"readOnly": true
},
"total_no_vat": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"readOnly": true,
"type": "string"
},
"total_vat": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"readOnly": true,
"type": "string"
},
"total_with_vat": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"vat": {
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"PatchedMetafield": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"choices": {
"items": {
"maxLength": 100,
"type": "string"
},
"nullable": true,
"type": "array"
},
"choices_url": {
"format": "uri",
"maxLength": 200,
"nullable": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"field_name": {
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_editable": {
"description": "Editable by manager",
"type": "boolean"
},
"is_editable_assignee": {
"description": "Editable by assignee",
"type": "boolean"
},
"is_persistent": {
"description": "Metadata, that will be copied to on recurrence.",
"type": "boolean"
},
"is_required": {
"type": "boolean"
},
"is_searchable": {
"type": "boolean"
},
"key": {
"maxLength": 20,
"pattern": "[a-z0-9]+$",
"type": "string"
},
"label": {
"maxLength": 40,
"type": "string"
},
"namespace": {
"default": "gsmtasks",
"maxLength": 20,
"pattern": "[a-z0-9]+$",
"type": "string"
},
"ordering": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"show_in_detail_view": {
"type": "boolean"
},
"show_in_list_view": {
"type": "boolean"
},
"show_in_mobile_app": {
"type": "boolean"
},
"show_in_pod": {
"title": "Show in proof of delivery",
"type": "boolean"
},
"show_when_task_type_assignment": {
"type": "boolean"
},
"show_when_task_type_drop_off": {
"type": "boolean"
},
"show_when_task_type_pick_up": {
"type": "boolean"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"value_type": {
"$ref": "#/components/schemas/ValueTypeEnum"
}
},
"type": "object"
},
"PatchedNotificationTemplate": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"email_reply_to": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"event": {
"oneOf": [
{
"$ref": "#/components/schemas/EventEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"type": "boolean"
},
"message": {
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phones": {
"items": {
"maxLength": 128,
"type": "string"
},
"type": "array"
},
"recipient": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RecipientEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"scheduled_time_change": {
"type": "boolean"
},
"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"
}
]
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"via_app": {
"type": "boolean"
},
"via_email": {
"type": "boolean"
},
"via_sms": {
"type": "boolean"
}
},
"type": "object"
},
"PatchedOrderSerializerV2": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"auto_assign": {
"type": "boolean"
},
"client": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"documents": {
"items": {
"format": "uri",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"orderer": {
"$ref": "#/components/schemas/NestedContact"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"tasks": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"tasks_data": {
"items": {
"$ref": "#/components/schemas/TaskSerializerV2"
},
"type": "array",
"writeOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedPushNotification": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"error": {
"nullable": true,
"type": "string"
},
"event": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EventEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"external_id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"message": {
"type": "string"
},
"notification": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"pending_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"recipient": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"sent_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/PushNotificationStateEnum"
}
],
"readOnly": true
},
"subject": {
"type": "string"
},
"task": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedRecurrence": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"default": true,
"type": "boolean"
},
"last_recurred_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"last_scheduled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"next_scheduled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"order": {
"format": "uri",
"type": "string"
},
"rrule": {
"type": "string"
},
"tasks_data": {
"additionalProperties": {},
"type": "object"
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedRoute": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assignee": {
"format": "uri",
"type": "string"
},
"code": {
"maxLength": 100,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"end_location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"end_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"start_location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"start_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedSMS": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"alphanumeric_sender_id": {
"maxLength": 20,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"error": {
"nullable": true,
"type": "string"
},
"external_id": {
"maxLength": 34,
"type": "string"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"type": "string"
},
"notification": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"received_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"segments_count": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"sender": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"sent_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/EmailStateEnum"
}
],
"readOnly": true
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedTaskForm": {
"properties": {
"completed": {
"type": "boolean"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"edit_url": {
"format": "uri",
"maxLength": 200,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"link": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 50,
"type": "string"
},
"pdf_url": {
"format": "uri",
"maxLength": 200,
"type": "string"
},
"task": {
"format": "uri",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"view_url": {
"format": "uri",
"maxLength": 200,
"type": "string"
}
},
"type": "object"
},
"PatchedTaskSerializerV2": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"actions": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"assignee_proximity": {
"allOf": [
{
"$ref": "#/components/schemas/AssigneeProximityEnum"
}
],
"readOnly": true
},
"auto_assign": {
"type": "boolean"
},
"barcodes": {
"items": {
"maxLength": 128,
"type": "string"
},
"type": "array"
},
"cancelled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"category": {
"$ref": "#/components/schemas/TaskCategoryEnum"
},
"complete_after": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"complete_before": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"contact": {
"$ref": "#/components/schemas/NestedContact"
},
"contact_address": {
"format": "uri",
"nullable": true,
"type": "string",
"writeOnly": true
},
"contact_address_external_id": {
"nullable": true,
"type": "string",
"writeOnly": true
},
"counts": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"documents": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"forms": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"issues": {
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"metafields": {
"additionalProperties": {},
"type": "object"
},
"order": {
"format": "uri",
"nullable": true,
"type": "string"
},
"orderer": {
"format": "uri",
"nullable": true,
"type": "string",
"writeOnly": true
},
"orderer_name": {
"readOnly": true,
"type": "string"
},
"position": {
"format": "double",
"maximum": 253402300799,
"minimum": 0,
"nullable": true,
"type": "number"
},
"priority": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"route": {
"format": "uri",
"nullable": true,
"type": "string"
},
"scheduled_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"signatures": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"size": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"nullable": true,
"type": "array"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskStateEnum"
}
],
"readOnly": true
},
"trackers": {
"items": {
"format": "uri",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedTimeLocationFeature": {
"description": "A subclass of ModelSerializer\nthat outputs geojson-ready data as\nfeatures and feature collections",
"properties": {
"accuracy": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"altitude": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"battery_level": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,3})?$",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"heading": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"model": {
"readOnly": true,
"type": "string"
},
"source": {
"readOnly": true,
"type": "string"
},
"speed": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"state": {
"$ref": "#/components/schemas/TimeLocationStateEnum"
},
"time": {
"format": "date-time",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedTracker": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"active_from": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"active_states": {
"items": {
"$ref": "#/components/schemas/TaskStateEnum"
},
"type": "array"
},
"active_until": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"autozoom": {
"type": "boolean"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"max_zoom_level": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"queued_states": {
"items": {
"$ref": "#/components/schemas/TaskStateEnum"
},
"type": "array"
},
"reviewed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"reviews_allowed": {
"type": "boolean"
},
"show_call_action": {
"type": "boolean"
},
"show_destination": {
"type": "boolean"
},
"show_driver_info": {
"type": "boolean"
},
"show_eta": {
"type": "boolean"
},
"show_logo": {
"type": "boolean"
},
"show_path": {
"type": "boolean"
},
"show_predicted_delivery": {
"type": "boolean"
},
"show_sms_action": {
"type": "boolean"
},
"tasks": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"tracking_page_url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PatchedWebhook": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"activated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"disable_message": {
"readOnly": true,
"type": "string"
},
"disabled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"document_events": {
"type": "boolean"
},
"failure_count": {
"readOnly": true,
"type": "integer"
},
"headers": {
"additionalProperties": {},
"type": "object"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"notification_emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"review_events": {
"type": "boolean"
},
"shared_secret": {
"maxLength": 40,
"type": "string"
},
"signature_events": {
"type": "boolean"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookStateEnum"
}
],
"readOnly": true
},
"target": {
"format": "uri",
"maxLength": 200,
"type": "string"
},
"task_events": {
"type": "boolean"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"version": {
"$ref": "#/components/schemas/VersionEnum"
}
},
"type": "object"
},
"PublicUser": {
"properties": {
"display_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"display_name",
"email",
"id",
"url"
],
"type": "object"
},
"PushNotification": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"error": {
"nullable": true,
"type": "string"
},
"event": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EventEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"external_id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"message": {
"type": "string"
},
"notification": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"pending_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"recipient": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"sent_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/PushNotificationStateEnum"
}
],
"readOnly": true
},
"subject": {
"type": "string"
},
"task": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_at",
"failed_at",
"id",
"message",
"notification",
"pending_at",
"recipient",
"sent_at",
"state",
"task",
"url"
],
"type": "object"
},
"PushNotificationStateEnum": {
"enum": [
"queued",
"pending",
"failed",
"sent"
],
"type": "string"
},
"ReadableUser": {
"properties": {
"display_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"type": "string"
},
"first_name": {
"maxLength": 30,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"intercom_hash": {
"readOnly": true,
"type": "string"
},
"last_name": {
"maxLength": 30,
"type": "string"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"signature_image": {
"format": "uri",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"display_name",
"email",
"id",
"intercom_hash",
"url"
],
"type": "object"
},
"RecipientEnum": {
"enum": [
"account",
"assignee",
"orderer",
"contact",
"client"
],
"type": "string"
},
"Recurrence": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"is_active": {
"default": true,
"type": "boolean"
},
"last_recurred_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"last_scheduled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"next_scheduled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"order": {
"format": "uri",
"type": "string"
},
"rrule": {
"type": "string"
},
"tasks_data": {
"additionalProperties": {},
"type": "object"
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_at",
"created_by",
"id",
"last_recurred_at",
"last_scheduled_at",
"next_scheduled_at",
"order",
"rrule",
"updated_at",
"url"
],
"type": "object"
},
"RecurrenceListScene": {
"properties": {
"assignees": {
"items": {
"$ref": "#/components/schemas/ReadableUser"
},
"type": "array"
},
"clients": {
"items": {
"$ref": "#/components/schemas/Client"
},
"type": "array"
},
"orders": {
"items": {
"$ref": "#/components/schemas/Order"
},
"type": "array"
},
"recurrences": {
"items": {
"$ref": "#/components/schemas/Recurrence"
},
"type": "array"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/Task"
},
"type": "array"
}
},
"required": [
"assignees",
"clients",
"orders",
"recurrences",
"tasks"
],
"type": "object"
},
"Registration": {
"properties": {
"account": {
"$ref": "#/components/schemas/RegistrationAccount"
},
"token": {
"readOnly": true,
"type": "string"
},
"user": {
"$ref": "#/components/schemas/RegistrationUser"
}
},
"required": [
"account",
"token",
"user"
],
"type": "object"
},
"RegistrationAccount": {
"properties": {
"country_code": {
"oneOf": [
{
"$ref": "#/components/schemas/CountryCodeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"language": {
"allOf": [
{
"$ref": "#/components/schemas/LanguageEnum"
}
],
"title": "Prefered language"
},
"name": {
"maxLength": 100,
"type": "string"
},
"timezone": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TimezoneEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"type": {
"oneOf": [
{
"$ref": "#/components/schemas/Type21dEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"website": {
"maxLength": 200,
"type": "string"
}
},
"required": [
"id",
"name",
"url"
],
"type": "object"
},
"RegistrationUser": {
"properties": {
"email": {
"format": "email",
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"maxLength": 100,
"minLength": 6,
"type": "string",
"writeOnly": true
},
"phone": {
"maxLength": 128,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"email",
"id",
"name",
"password",
"url"
],
"type": "object"
},
"RenderRequest": {
"properties": {
"task": {
"format": "uri",
"type": "string"
}
},
"required": [
"task"
],
"type": "object"
},
"Review": {
"properties": {
"comment": {
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"last_assignee": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"last_task": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"rating": {
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"tracker": {
"format": "uri",
"type": "string"
}
},
"required": [
"created_at",
"id",
"last_assignee",
"last_task",
"rating",
"tracker"
],
"type": "object"
},
"Route": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assignee": {
"format": "uri",
"type": "string"
},
"code": {
"maxLength": 100,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"end_location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"end_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"start_location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"start_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"code",
"created_at",
"id",
"updated_at",
"url"
],
"type": "object"
},
"RouteOptimizationSerializerV2": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assignees": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"commit": {
"type": "boolean"
},
"commited_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"type": "string"
},
"end_location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"errors": {
"format": "json-pointer",
"readOnly": true,
"type": "string"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"objective": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ObjectiveEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"ready_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"scheduled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"start_location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"start_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"started_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/RouteOptimizationSerializerV2StateEnum"
}
],
"readOnly": true
},
"tasks": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"total_distance": {
"readOnly": true,
"type": "integer"
},
"total_duration": {
"default": "4 10:55:34.12",
"readOnly": true,
"type": "object"
},
"unassign_not_optimal": {
"type": "boolean"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"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"
],
"type": "object"
},
"RouteOptimizationSerializerV2StateEnum": {
"enum": [
"pending",
"started",
"ready",
"completed",
"over_quota",
"failed"
],
"type": "string"
},
"S3FileUpload": {
"description": "Saves either a file or file_url.\nin case S3 is used, it requires file name and file type and after save returns an upload url and saves the url.\n\nThis serializer can not be used in other serializers if Amazon S3 upload is used.",
"properties": {
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"file": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"file_name": {
"maxLength": 100,
"type": "string",
"writeOnly": true
},
"file_type": {
"maxLength": 100,
"type": "string",
"writeOnly": true
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"s3_signature": {
"additionalProperties": {},
"nullable": true,
"readOnly": true,
"type": "object"
},
"source": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SourceEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"created_at",
"created_by",
"file",
"file_name",
"file_type",
"id",
"s3_signature",
"updated_at",
"url"
],
"type": "object"
},
"SMS": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"alphanumeric_sender_id": {
"maxLength": 20,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"error": {
"nullable": true,
"type": "string"
},
"external_id": {
"maxLength": 34,
"type": "string"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"message": {
"nullable": true,
"type": "string"
},
"notification": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"phone": {
"maxLength": 128,
"type": "string"
},
"received_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"segments_count": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"sender": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"sent_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/EmailStateEnum"
}
],
"readOnly": true
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_at",
"failed_at",
"id",
"notification",
"phone",
"received_at",
"sender",
"sent_at",
"state",
"url"
],
"type": "object"
},
"Signature": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"documents": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"file": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"file_name": {
"readOnly": true,
"type": "string"
},
"file_upload": {
"format": "uri",
"type": "string",
"writeOnly": true
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"mimetype": {
"readOnly": true,
"type": "string"
},
"signer": {
"$ref": "#/components/schemas/NestedContact"
},
"source": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SourceEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"task": {
"format": "uri",
"type": "string"
},
"thumbnail": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"created_at",
"created_by",
"file",
"file_name",
"file_upload",
"id",
"mimetype",
"signer",
"task",
"thumbnail",
"updated_at",
"url"
],
"type": "object"
},
"SignatureDeleteAction": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"signatures": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
}
},
"required": [
"account",
"signatures"
],
"type": "object"
},
"SourceEnum": {
"enum": [
"web",
"mobile",
"integration"
],
"type": "string"
},
"StatusEnum": {
"enum": [
"on_duty",
"off_duty"
],
"type": "string"
},
"StripePayment": {
"properties": {
"amount": {
"format": "decimal",
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$",
"type": "string"
},
"billable_account": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"currency": {
"maxLength": 3,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"invoice": {
"format": "uri",
"nullable": true,
"type": "string"
},
"response": {
"nullable": true,
"type": "string"
},
"state": {
"$ref": "#/components/schemas/StripePaymentStateEnum"
},
"stripe_id": {
"maxLength": 36,
"nullable": true,
"type": "string"
},
"stripe_state": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StripeStateEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"timestamp": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount",
"billable_account",
"created_at",
"id",
"invoice",
"updated_at",
"url"
],
"type": "object"
},
"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": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"actions": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"assignee_proximity": {
"allOf": [
{
"$ref": "#/components/schemas/AssigneeProximityEnum"
}
],
"readOnly": true
},
"auto_assign": {
"type": "boolean"
},
"cancelled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"category": {
"$ref": "#/components/schemas/TaskCategoryEnum"
},
"complete_after": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"complete_before": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"contact": {
"$ref": "#/components/schemas/NestedContact"
},
"counts": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"documents": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"events": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"forms": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"is_full_load": {
"type": "boolean"
},
"issues": {
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"metafields": {
"additionalProperties": {},
"type": "object"
},
"order": {
"format": "uri",
"nullable": true,
"type": "string"
},
"order_reference": {
"readOnly": true,
"type": "string"
},
"orderer": {
"format": "uri",
"nullable": true,
"type": "string"
},
"orderer_name": {
"readOnly": true,
"type": "string"
},
"position": {
"format": "double",
"maximum": 253402300799,
"minimum": 0,
"nullable": true,
"type": "number"
},
"priority": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"receiver": {
"format": "uri",
"nullable": true,
"type": "string"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"route": {
"format": "uri",
"nullable": true,
"type": "string"
},
"scheduled_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"signatures": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"size": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"nullable": true,
"type": "array"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskStateEnum"
}
],
"readOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"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"
],
"type": "object"
},
"TaskAccountChange": {
"properties": {
"account": {
"format": "uri",
"type": "string"
}
},
"required": [
"account"
],
"type": "object"
},
"TaskAction": {
"properties": {
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"notes": {
"type": "string"
}
},
"type": "object"
},
"TaskAddressFeature": {
"description": "A subclass of ModelSerializer\nthat outputs geojson-ready data as\nfeatures and feature collections",
"properties": {
"category": {
"$ref": "#/components/schemas/TaskCategoryEnum"
},
"formatted_address": {
"readOnly": true,
"type": "string"
},
"geometry": {
"$ref": "#/components/schemas/Location"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"model": {
"readOnly": true,
"type": "string"
},
"state": {
"$ref": "#/components/schemas/TaskStateEnum"
},
"task": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"formatted_address",
"geometry",
"id",
"model",
"task"
],
"type": "object"
},
"TaskAssign": {
"properties": {
"assignee": {
"format": "uri",
"type": "string"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"notes": {
"type": "string"
}
},
"required": [
"assignee"
],
"type": "object"
},
"TaskCategoryEnum": {
"enum": [
"assignment",
"pick_up",
"drop_off",
"warehouse"
],
"type": "string"
},
"TaskCommand": {
"properties": {
"accepted_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"account": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"action": {
"$ref": "#/components/schemas/ActionEnum"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"error_message": {
"type": "string"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"notes": {
"description": "Task command notes",
"type": "string"
},
"rejected_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"state": {
"$ref": "#/components/schemas/TaskCommandStateEnum"
},
"task": {
"format": "uri",
"type": "string"
},
"task_data": {
"$ref": "#/components/schemas/TaskCommandTaskData"
},
"time": {
"format": "date-time",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"action",
"created_at",
"id",
"task",
"time",
"updated_at",
"url",
"user"
],
"type": "object"
},
"TaskCommandStateEnum": {
"enum": [
"pending",
"accepted",
"rejected"
],
"type": "string"
},
"TaskCommandTaskData": {
"properties": {
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"metafields": {
"additionalProperties": {},
"type": "object"
},
"position": {
"format": "double",
"maximum": 253402300799,
"minimum": 0,
"type": "number"
},
"scheduled_time": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"TaskEvent": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assignee": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/EventEnum"
}
],
"readOnly": true
},
"field": {
"oneOf": [
{
"$ref": "#/components/schemas/FieldEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
],
"readOnly": true
},
"from_state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskEventTransitionStatesEnum"
}
],
"readOnly": true
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"notes": {
"description": "Event notes",
"type": "string"
},
"task": {
"format": "uri",
"type": "string"
},
"task_command": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"to_state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskEventTransitionStatesEnum"
}
],
"readOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"assignee",
"created_at",
"event",
"field",
"from_state",
"id",
"task",
"task_command",
"to_state",
"updated_at",
"url",
"user"
],
"type": "object"
},
"TaskEventSerializerV2": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assignee": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/EventEnum"
}
],
"readOnly": true
},
"field": {
"oneOf": [
{
"$ref": "#/components/schemas/FieldEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
],
"readOnly": true
},
"from_state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskEventTransitionStatesEnum"
}
],
"readOnly": true
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"nullable": true
},
"notes": {
"description": "Event notes",
"type": "string"
},
"task": {
"$ref": "#/components/schemas/TaskEventTask"
},
"task_command": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"to_state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskEventTransitionStatesEnum"
}
],
"readOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"assignee",
"created_at",
"event",
"field",
"from_state",
"id",
"task",
"task_command",
"to_state",
"updated_at",
"url",
"user"
],
"type": "object"
},
"TaskEventTask": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"actions": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"assignee_proximity": {
"allOf": [
{
"$ref": "#/components/schemas/AssigneeProximityEnum"
}
],
"readOnly": true
},
"auto_assign": {
"type": "boolean"
},
"barcodes": {
"items": {
"maxLength": 128,
"type": "string"
},
"type": "array"
},
"cancelled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"category": {
"$ref": "#/components/schemas/TaskCategoryEnum"
},
"complete_after": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"complete_before": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"contact": {
"$ref": "#/components/schemas/NestedContact"
},
"contact_address": {
"format": "uri",
"nullable": true,
"type": "string",
"writeOnly": true
},
"contact_address_external_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"counts": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"documents": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"forms": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"issues": {
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"metafields": {
"additionalProperties": {},
"type": "object"
},
"order": {
"format": "uri",
"nullable": true,
"type": "string"
},
"orderer": {
"format": "uri",
"nullable": true,
"type": "string",
"writeOnly": true
},
"orderer_name": {
"readOnly": true,
"type": "string"
},
"position": {
"format": "double",
"maximum": 253402300799,
"minimum": 0,
"nullable": true,
"type": "number"
},
"priority": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"route": {
"format": "uri",
"nullable": true,
"type": "string"
},
"scheduled_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"signatures": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"size": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"nullable": true,
"type": "array"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskStateEnum"
}
],
"readOnly": true
},
"trackers": {
"items": {
"format": "uri",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"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"
],
"type": "object"
},
"TaskEventTrack": {
"description": "A subclass of ModelSerializer\nthat outputs geojson-ready data as\nfeatures and feature collections",
"properties": {
"assignee": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/EventEnum"
}
],
"readOnly": true
},
"from_state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskEventTransitionStatesEnum"
}
],
"readOnly": true
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"model": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Event notes",
"type": "string"
},
"task": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"task_event": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"to_state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskEventTransitionStatesEnum"
}
],
"readOnly": true
},
"track": {
"allOf": [
{
"$ref": "#/components/schemas/Location"
}
],
"readOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uuid",
"readOnly": true,
"type": "string"
}
},
"required": [
"created_at",
"event",
"from_state",
"id",
"model",
"task",
"task_event",
"to_state",
"track",
"updated_at",
"url",
"user"
],
"type": "object"
},
"TaskEventTransitionStatesEnum": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled",
"away",
"near"
],
"type": "string"
},
"TaskExpiryStateEnum": {
"enum": [
"cancelled",
"completed"
],
"type": "string"
},
"TaskExport": {
"properties": {
"account__name": {
"type": "string"
},
"address__apartment_number": {
"default": "",
"type": "string"
},
"address__city": {
"default": "",
"type": "string"
},
"address__country": {
"default": "",
"type": "string"
},
"address__country_code": {
"default": "",
"type": "string"
},
"address__formatted_address": {
"default": "",
"type": "string"
},
"address__geocode_failed_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"address__geocoded_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"address__google_place_id": {
"default": "",
"type": "string"
},
"address__house_number": {
"default": "",
"type": "string"
},
"address__location": {
"$ref": "#/components/schemas/Location"
},
"address__point_of_interest": {
"default": "",
"type": "string"
},
"address__postal_code": {
"default": "",
"type": "string"
},
"address__raw_address": {
"default": "",
"type": "string"
},
"address__state": {
"default": "",
"type": "string"
},
"address__street": {
"default": "",
"type": "string"
},
"assignee__display_name": {
"readOnly": true,
"type": "string"
},
"assignee__email": {
"default": "",
"format": "email",
"type": "string"
},
"assignee__phone": {
"default": "",
"type": "string"
},
"assignee_proximity": {
"$ref": "#/components/schemas/AssigneeProximityEnum"
},
"auto_assign": {
"type": "boolean"
},
"cancelled_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"category": {
"$ref": "#/components/schemas/TaskCategoryEnum"
},
"complete_after": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"complete_before": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"contact__company": {
"default": "",
"type": "string"
},
"contact__emails": {
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"contact__name": {
"default": "",
"type": "string"
},
"contact__notes": {
"default": "",
"type": "string"
},
"contact__phones": {
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"contact_address_external_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by__display_name": {
"readOnly": true,
"type": "string"
},
"created_by__email": {
"default": "",
"format": "email",
"type": "string"
},
"created_by__phone": {
"default": "",
"type": "string"
},
"description": {
"type": "string"
},
"duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"is_full_load": {
"type": "boolean"
},
"issues": {
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"metadata__accepted_distance": {
"type": "integer"
},
"metadata__accepted_duration": {
"default": "4 10:55:34.12",
"type": "object"
},
"metadata__active_distance": {
"type": "integer"
},
"metadata__active_duration": {
"default": "4 10:55:34.12",
"type": "object"
},
"metadata__assigned_distance": {
"type": "integer"
},
"metadata__assigned_duration": {
"default": "4 10:55:34.12",
"type": "object"
},
"metadata__cancelled_distance": {
"type": "integer"
},
"metadata__cancelled_duration": {
"default": "4 10:55:34.12",
"type": "object"
},
"metadata__completed_distance": {
"type": "integer"
},
"metadata__completed_duration": {
"default": "4 10:55:34.12",
"type": "object"
},
"metadata__documents_count": {
"type": "integer"
},
"metadata__events_count": {
"type": "integer"
},
"metadata__failed_distance": {
"type": "integer"
},
"metadata__failed_duration": {
"default": "4 10:55:34.12",
"type": "object"
},
"metadata__forms_completed_count": {
"type": "integer"
},
"metadata__forms_count": {
"type": "integer"
},
"metadata__last_accepted_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"metadata__last_active_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"metadata__last_assigned_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"metadata__last_cancelled_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"metadata__last_completed_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"metadata__last_failed_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"metadata__last_task_event_notes": {
"default": "",
"type": "string"
},
"metadata__last_transit_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"metadata__last_unassigned_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"metadata__signatures_count": {
"type": "integer"
},
"metadata__task_event_notes_count": {
"default": 0,
"type": "integer"
},
"metadata__transit_distance": {
"type": "integer"
},
"metadata__transit_duration": {
"default": "4 10:55:34.12",
"type": "object"
},
"metadata__unassigned_distance": {
"type": "integer"
},
"metadata__unassigned_duration": {
"default": "4 10:55:34.12",
"type": "object"
},
"order__auto_assign": {
"default": "",
"type": "string"
},
"order__created_at": {
"default": null,
"format": "date-time",
"type": "string"
},
"order__created_by": {
"default": "",
"type": "string"
},
"order__external_id": {
"default": "",
"type": "string"
},
"order__id": {
"default": "",
"type": "string"
},
"order__orderer__company": {
"default": "",
"type": "string"
},
"order__orderer__emails": {
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"order__orderer__name": {
"default": "",
"type": "string"
},
"order__orderer__notes": {
"default": "",
"type": "string"
},
"order__orderer__phones": {
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"order__reference": {
"default": "",
"type": "string"
},
"orderer__name": {
"default": "",
"type": "string"
},
"position": {
"format": "double",
"maximum": 253402300799,
"minimum": 0,
"nullable": true,
"type": "number"
},
"priority": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"route__code": {
"default": "",
"type": "string"
},
"route__description": {
"default": "",
"type": "string"
},
"scheduled_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"size": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"nullable": true,
"type": "array"
},
"state": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"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"
],
"type": "object"
},
"TaskForm": {
"properties": {
"completed": {
"type": "boolean"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"edit_url": {
"format": "uri",
"maxLength": 200,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"link": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 50,
"type": "string"
},
"pdf_url": {
"format": "uri",
"maxLength": 200,
"type": "string"
},
"task": {
"format": "uri",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"view_url": {
"format": "uri",
"maxLength": 200,
"type": "string"
}
},
"required": [
"created_at",
"edit_url",
"id",
"link",
"name",
"task",
"updated_at",
"url"
],
"type": "object"
},
"TaskListReorderRequest": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assign_tasks": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"reorder_tasks": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
}
},
"required": [
"account",
"assign_tasks",
"assignee",
"reorder_tasks"
],
"type": "object"
},
"TaskListScene": {
"properties": {
"clients": {
"items": {
"$ref": "#/components/schemas/Client"
},
"type": "array"
},
"orders": {
"items": {
"$ref": "#/components/schemas/Order"
},
"type": "array"
},
"task_events_with_notes": {
"items": {
"$ref": "#/components/schemas/TaskEvent"
},
"type": "array"
},
"task_metadatas": {
"items": {
"$ref": "#/components/schemas/TaskMetadata"
},
"type": "array"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/LegacyTask"
},
"type": "array"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"users": {
"items": {
"$ref": "#/components/schemas/PublicUser"
},
"type": "array"
}
},
"required": [
"clients",
"orders",
"task_events_with_notes",
"task_metadatas",
"tasks",
"updated_at",
"users"
],
"type": "object"
},
"TaskMetadata": {
"properties": {
"accepted_distance": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"accepted_duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"active_distance": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"active_duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"assigned_distance": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"assigned_duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"cancelled_distance": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"cancelled_duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"completed_distance": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"completed_duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"documents_count": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"events_count": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"failed_distance": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"failed_duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"forms_completed_count": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"forms_count": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"last_accepted_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_active_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_assigned_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_cancelled_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_completed_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_failed_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_task_event_notes": {
"type": "string"
},
"last_transit_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_unassigned_at": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"signatures_count": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"task": {
"format": "uri",
"type": "string"
},
"task_event_notes_count": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"transit_distance": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"transit_duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"unassigned_distance": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"type": "integer"
},
"unassigned_duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"id",
"task",
"url"
],
"type": "object"
},
"TaskSerializerV2": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"actions": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"address": {
"$ref": "#/components/schemas/NestedAddress"
},
"assignee": {
"format": "uri",
"nullable": true,
"type": "string"
},
"assignee_proximity": {
"allOf": [
{
"$ref": "#/components/schemas/AssigneeProximityEnum"
}
],
"readOnly": true
},
"auto_assign": {
"type": "boolean"
},
"barcodes": {
"items": {
"maxLength": 128,
"type": "string"
},
"type": "array"
},
"cancelled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"category": {
"$ref": "#/components/schemas/TaskCategoryEnum"
},
"complete_after": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"complete_before": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"contact": {
"$ref": "#/components/schemas/NestedContact"
},
"contact_address": {
"format": "uri",
"nullable": true,
"type": "string",
"writeOnly": true
},
"contact_address_external_id": {
"nullable": true,
"type": "string",
"writeOnly": true
},
"counts": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"documents": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"duration": {
"default": "4 10:55:34.12",
"nullable": true,
"type": "object"
},
"external_id": {
"maxLength": 100,
"nullable": true,
"type": "string"
},
"forms": {
"additionalProperties": {},
"readOnly": true,
"type": "object"
},
"id": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"issues": {
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"metafields": {
"additionalProperties": {},
"type": "object"
},
"order": {
"format": "uri",
"nullable": true,
"type": "string"
},
"orderer": {
"format": "uri",
"nullable": true,
"type": "string",
"writeOnly": true
},
"orderer_name": {
"readOnly": true,
"type": "string"
},
"position": {
"format": "double",
"maximum": 253402300799,
"minimum": 0,
"nullable": true,
"type": "number"
},
"priority": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"reference": {
"maxLength": 100,
"type": "string"
},
"route": {
"format": "uri",
"nullable": true,
"type": "string"
},
"scheduled_time": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"signatures": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"size": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"nullable": true,
"type": "array"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/TaskStateEnum"
}
],
"readOnly": true
},
"trackers": {
"items": {
"format": "uri",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"actions",
"assignee_proximity",
"cancelled_at",
"completed_at",
"counts",
"created_at",
"forms",
"issues",
"orderer_name",
"state",
"trackers",
"updated_at",
"url"
],
"type": "object"
},
"TaskStateEnum": {
"enum": [
"unassigned",
"assigned",
"accepted",
"transit",
"active",
"completed",
"failed",
"cancelled"
],
"type": "string"
},
"TasksBackgroundImport": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"assignees": {
"items": {
"format": "uri",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"celery_task_id": {
"maxLength": 50,
"nullable": true,
"type": "string"
},
"completed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"errors": {
"additionalProperties": {},
"type": "object"
},
"failed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"mapping": {
"format": "uri",
"nullable": true,
"type": "string"
},
"started_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/TasksBackgroundImportStateEnum"
}
],
"readOnly": true
},
"tasks_created": {
"items": {
"format": "uri",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"tasks_data": {
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array",
"writeOnly": true
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"assignees",
"completed_at",
"created_at",
"created_by",
"failed_at",
"id",
"started_at",
"state",
"tasks_created",
"tasks_data",
"updated_at",
"url"
],
"type": "object"
},
"TasksBackgroundImportStateEnum": {
"enum": [
"pending",
"started",
"completed",
"failed"
],
"type": "string"
},
"TasksStatesCount": {
"properties": {
"accepted": {
"default": 0,
"readOnly": true,
"type": "integer"
},
"active": {
"default": 0,
"readOnly": true,
"type": "integer"
},
"assigned": {
"default": 0,
"readOnly": true,
"type": "integer"
},
"cancelled": {
"default": 0,
"readOnly": true,
"type": "integer"
},
"completed": {
"default": 0,
"readOnly": true,
"type": "integer"
},
"failed": {
"default": 0,
"readOnly": true,
"type": "integer"
},
"transit": {
"default": 0,
"readOnly": true,
"type": "integer"
},
"unassigned": {
"default": 0,
"readOnly": true,
"type": "integer"
}
},
"required": [
"accepted",
"active",
"assigned",
"cancelled",
"completed",
"failed",
"transit",
"unassigned"
],
"type": "object"
},
"TasksStatesCountResponse": {
"properties": {
"dates": {
"additionalProperties": {
"$ref": "#/components/schemas/TasksStatesCount"
},
"readOnly": true,
"type": "object"
}
},
"required": [
"dates"
],
"type": "object"
},
"TimeFormatEnum": {
"enum": [
"HH:mm",
"h:mm A"
],
"type": "string"
},
"TimeLocation": {
"properties": {
"accuracy": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"altitude": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"battery_level": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,3})?$",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"heading": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"source": {
"readOnly": true,
"type": "string"
},
"speed": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"state": {
"$ref": "#/components/schemas/TimeLocationStateEnum"
},
"time": {
"format": "date-time",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"created_at",
"id",
"location",
"source",
"time",
"updated_at",
"url",
"user"
],
"type": "object"
},
"TimeLocationFeature": {
"description": "A subclass of ModelSerializer\nthat outputs geojson-ready data as\nfeatures and feature collections",
"properties": {
"accuracy": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"altitude": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"battery_level": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,3})?$",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"heading": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"model": {
"readOnly": true,
"type": "string"
},
"source": {
"readOnly": true,
"type": "string"
},
"speed": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"state": {
"$ref": "#/components/schemas/TimeLocationStateEnum"
},
"time": {
"format": "date-time",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"created_at",
"id",
"location",
"model",
"source",
"time",
"updated_at",
"user"
],
"type": "object"
},
"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": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"active_from": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"active_states": {
"items": {
"$ref": "#/components/schemas/TaskStateEnum"
},
"type": "array"
},
"active_until": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"autozoom": {
"type": "boolean"
},
"created_by": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"max_zoom_level": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"queued_states": {
"items": {
"$ref": "#/components/schemas/TaskStateEnum"
},
"type": "array"
},
"reviewed_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"reviews_allowed": {
"type": "boolean"
},
"show_call_action": {
"type": "boolean"
},
"show_destination": {
"type": "boolean"
},
"show_driver_info": {
"type": "boolean"
},
"show_eta": {
"type": "boolean"
},
"show_logo": {
"type": "boolean"
},
"show_path": {
"type": "boolean"
},
"show_predicted_delivery": {
"type": "boolean"
},
"show_sms_action": {
"type": "boolean"
},
"tasks": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"tracking_page_url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
}
},
"required": [
"account",
"created_by",
"id",
"reviewed_at",
"tasks",
"tracking_page_url",
"url"
],
"type": "object"
},
"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": {
"properties": {
"password": {
"type": "string",
"writeOnly": true
},
"token": {
"format": "uuid",
"type": "string",
"writeOnly": true
}
},
"required": [
"token"
],
"type": "object"
},
"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": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"activated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"disable_message": {
"readOnly": true,
"type": "string"
},
"disabled_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"document_events": {
"type": "boolean"
},
"failure_count": {
"readOnly": true,
"type": "integer"
},
"headers": {
"additionalProperties": {},
"type": "object"
},
"id": {
"format": "uuid",
"readOnly": true,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"notification_emails": {
"items": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"type": "array"
},
"review_events": {
"type": "boolean"
},
"shared_secret": {
"maxLength": 40,
"type": "string"
},
"signature_events": {
"type": "boolean"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookStateEnum"
}
],
"readOnly": true
},
"target": {
"format": "uri",
"maxLength": 200,
"type": "string"
},
"task_events": {
"type": "boolean"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"version": {
"$ref": "#/components/schemas/VersionEnum"
}
},
"required": [
"account",
"activated_at",
"created_at",
"disable_message",
"disabled_at",
"failure_count",
"id",
"name",
"state",
"target",
"updated_at",
"url"
],
"type": "object"
},
"WebhookStateEnum": {
"enum": [
"inactive",
"active",
"disabled"
],
"type": "string"
},
"WorkerFeature": {
"description": "A subclass of ModelSerializer\nthat outputs geojson-ready data as\nfeatures and feature collections",
"properties": {
"accuracy": {
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true,
"type": "integer"
},
"altitude": {
"nullable": true,
"type": "integer"
},
"battery_level": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,3})?$",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"heading": {
"nullable": true,
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"model": {
"readOnly": true,
"type": "string"
},
"source": {
"readOnly": true,
"type": "string"
},
"speed": {
"nullable": true,
"type": "integer"
},
"state": {
"$ref": "#/components/schemas/TimeLocationStateEnum"
},
"time": {
"format": "date-time",
"type": "string"
},
"time_location": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"user_name": {
"readOnly": true,
"type": "string"
}
},
"required": [
"created_at",
"id",
"location",
"model",
"source",
"time",
"time_location",
"updated_at",
"url",
"user",
"user_name"
],
"type": "object"
},
"WorkerTrack": {
"description": "A subclass of ModelSerializer\nthat outputs geojson-ready data as\nfeatures and feature collections",
"properties": {
"end_time": {
"format": "date-time",
"type": "string"
},
"id": {
"readOnly": true,
"type": "string"
},
"start_time": {
"format": "date-time",
"type": "string"
},
"track": {
"$ref": "#/components/schemas/Location"
},
"user": {
"format": "uuid",
"type": "string"
}
},
"required": [
"end_time",
"id",
"start_time",
"track",
"user"
],
"type": "object"
},
"WorkingState": {
"properties": {
"account": {
"format": "uri",
"type": "string"
},
"account_role": {
"format": "uri",
"type": "string"
},
"created_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"mode": {
"$ref": "#/components/schemas/ModeEnum"
},
"status": {
"$ref": "#/components/schemas/StatusEnum"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"user": {
"format": "uri",
"type": "string"
}
},
"required": [
"created_at",
"status"
],
"type": "object"
}
},
"securitySchemes": {
"tokenAuth": {
"description": "Token-based authentication with required prefix \"Token\"",
"in": "header",
"name": "Authorization",
"type": "apiKey"
}
}
}
}