---
title: /getCashboxes
slug: getcashboxes
createdAt: 2024-01-09T12:30:00.561Z
---

{
  "id": "MJNaYmH1gVyyqDtmYH4_Y",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "http://1.1.1.1/getCashboxes",
    "servers": [
      {
        "url": "http://1.1.1.1/getCashboxes"
      }
    ],
    "name": "",
    "description": "<p>param None</p>\n<ul>\n<li>return - array containing all cashboxes associated with accounts that user can view</li>\n</ul>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "customType": "getCashboxesRequest",
          "schema": [
            {
              "name": "FunctionData",
              "kind": "optional",
              "type": "object",
              "example": "",
              "schema": []
            },
            {
              "name": "Meta",
              "kind": "optional",
              "type": "object",
              "modelRef": "#/components/schemas/MetaTokengetCashboxes",
              "customType": "MetaTokengetCashboxes",
              "schema": [
                {
                  "name": "FunctionName",
                  "kind": "optional",
                  "type": "string",
                  "description": "The Function to be called",
                  "example": "getCashboxes",
                  "default": "getCashboxes"
                },
                {
                  "name": "RandomData",
                  "kind": "optional",
                  "type": "string",
                  "description": "Random Data",
                  "example": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
                  "default": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229"
                },
                {
                  "name": "Destination",
                  "kind": "optional",
                  "type": "string",
                  "description": "Id of the server",
                  "example": "",
                  "default": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea"
                },
                {
                  "name": "Time",
                  "kind": "optional",
                  "type": "string",
                  "description": "UTC Time of execution",
                  "example": "2021-02-07T18:37:46.948Z",
                  "default": "2021-02-07T18:37:46.948Z"
                },
                {
                  "name": "Source",
                  "kind": "optional",
                  "type": "string",
                  "description": "User public key",
                  "example": "",
                  "default": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99"
                },
                {
                  "name": "AccessToken",
                  "kind": "optional",
                  "type": "string",
                  "description": "Token used for authentication purposes",
                  "example": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087",
                  "default": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
                }
              ]
            }
          ],
          "modelRef": "#/components/schemas/getCashboxesRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "success",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "customType": "getCashboxesResponse",
            "schema": [
              {
                "name": "FunctionData",
                "kind": "optional",
                "type": "object",
                "example": "",
                "schema": [
                  {
                    "name": "Cashboxes",
                    "kind": "optional",
                    "type": "array",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "CashboxEthereumRealBalance",
                        "kind": "optional",
                        "type": "string",
                        "description": "Amount of ETH if this is an ERC20 cashbox",
                        "example": "null",
                        "default": "null"
                      },
                      {
                        "name": "CashboxRealBalance",
                        "kind": "optional",
                        "type": "string",
                        "description": "The current balance in this cashbox",
                        "example": "1000000",
                        "default": "1000000"
                      },
                      {
                        "name": "CashboxStatus",
                        "kind": "optional",
                        "type": "integer",
                        "description": "Status of the cashbox (Closed, Used, Created)",
                        "example": 2,
                        "default": 2
                      },
                      {
                        "name": "CashboxDataSignedByCold",
                        "kind": "optional",
                        "type": "object",
                        "example": "",
                        "schema": [
                          {
                            "name": "Data",
                            "kind": "optional",
                            "type": "object",
                            "example": "",
                            "schema": [
                              {
                                "name": "AccountId",
                                "kind": "optional",
                                "type": "integer",
                                "description": "The ID of the account of this cashbox",
                                "example": 1,
                                "default": 1
                              },
                              {
                                "name": "CashboxAddress",
                                "kind": "optional",
                                "type": "string",
                                "description": "The address of this cashbox",
                                "example": "12bej8oZDE6gveXds5Ze8VjXHWvFTcLyyC",
                                "default": "12bej8oZDE6gveXds5Ze8VjXHWvFTcLyyC"
                              },
                              {
                                "name": "CashboxContactName",
                                "kind": "optional",
                                "type": "string",
                                "description": "The contact name of the address of this cashbox",
                                "example": "Cashbox: BTC",
                                "default": "Cashbox: BTC"
                              },
                              {
                                "name": "CashboxCreationTime",
                                "kind": "optional",
                                "type": "string",
                                "description": "The time this cashbox was created (Unix time)",
                                "example": "1627303305",
                                "default": "1627303305"
                              },
                              {
                                "name": "CashboxId",
                                "kind": "optional",
                                "type": "integer",
                                "description": "The ID of this cashbox",
                                "example": 31,
                                "default": 31
                              },
                              {
                                "name": "CashboxName",
                                "kind": "optional",
                                "type": "string",
                                "description": "The name of this cashbox",
                                "example": "CashboxName",
                                "default": "CashboxName"
                              },
                              {
                                "name": "CurrencySymbol",
                                "kind": "optional",
                                "type": "string",
                                "description": "The symbol of the currency",
                                "example": "BTC",
                                "default": "BTC"
                              },
                              {
                                "name": "GasLimit",
                                "kind": "optional",
                                "type": "string",
                                "description": "The GasLimit used in this cashboxes transactions (if valid)",
                                "example": "null",
                                "default": "null"
                              },
                              {
                                "name": "Parts",
                                "kind": "optional",
                                "type": "integer",
                                "description": "The number of parts this cashbox was created with",
                                "example": 3,
                                "default": 3
                              },
                              {
                                "name": "Time",
                                "kind": "optional",
                                "type": "string",
                                "description": "The time of this request",
                                "example": "2021-07-26 12:52:36.659",
                                "default": "2021-07-26 12:52:36.659"
                              },
                              {
                                "name": "TotalAmount",
                                "kind": "optional",
                                "type": "string",
                                "description": "The Total amount in crypto for this cashbox",
                                "example": "300000000",
                                "default": "300000000"
                              },
                              {
                                "name": "CashboxDestinations",
                                "kind": "optional",
                                "type": "array",
                                "example": "",
                                "itemType": "object",
                                "customType": "object[]",
                                "schema": [
                                  {
                                    "name": "Address",
                                    "kind": "optional",
                                    "type": "string",
                                    "description": "One of the destination addresses of this cashbox",
                                    "example": "19Pxiuw1STqszL84kzyb2Jw5dFm541hyDd",
                                    "default": "19Pxiuw1STqszL84kzyb2Jw5dFm541hyDd"
                                  },
                                  {
                                    "name": "DestinationIndex",
                                    "kind": "optional",
                                    "type": "integer",
                                    "description": "The index of this destination address",
                                    "example": 0,
                                    "default": 0
                                  },
                                  {
                                    "name": "DestinationName",
                                    "kind": "optional",
                                    "type": "string",
                                    "description": "The name of the contact of the destination address",
                                    "example": "Account Main Account: MPC",
                                    "default": "Account Main Account: MPC"
                                  },
                                  {
                                    "name": "Protected",
                                    "kind": "optional",
                                    "type": "boolean",
                                    "description": "Whether the transactions to this address requires a password or not",
                                    "example": "True",
                                    "default": "True"
                                  }
                                ]
                              },
                              {
                                "name": "FeeOptions",
                                "kind": "optional",
                                "type": "array",
                                "description": "An array with the fee options for the cashbox transaction",
                                "example": "[\"[1,2,3,4,5,6,7,8,9,10]\"]",
                                "itemType": "integer",
                                "customType": "integer[]",
                                "itemExample": "[1,2,3,4,5,6,7,8,9,10]",
                                "itemDefault": [
                                  1,
                                  2,
                                  3,
                                  4,
                                  5,
                                  6,
                                  7,
                                  8,
                                  9,
                                  10
                                ],
                                "default": [
                                  "1,2,3,4,5,6,7,8,9,10"
                                ]
                              },
                              {
                                "name": "UsersIds",
                                "kind": "optional",
                                "type": "array",
                                "description": "An array with the ID of the users that have access to this cashbox",
                                "example": "[\"[\"bob@gk8.io\",\"alice@gk8.io\",\"david@gk8.io\"]\"]",
                                "itemType": "string",
                                "customType": "string[]",
                                "itemExample": "[\"bob@gk8.io\",\"alice@gk8.io\",\"david@gk8.io\"]",
                                "itemDefault": [
                                  "bob@gk8.io",
                                  "alice@gk8.io",
                                  "david@gk8.io"
                                ],
                                "default": [
                                  "bob@gk8.io,alice@gk8.io,david@gk8.io"
                                ]
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "name": "Meta",
                "kind": "optional",
                "type": "object",
                "modelRef": "#/components/schemas/MetaResponse",
                "customType": "MetaResponse",
                "schema": [
                  {
                    "name": "AccessToken",
                    "kind": "optional",
                    "type": "string",
                    "description": "The new access token generated after this operation",
                    "example": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
                    "default": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6"
                  },
                  {
                    "name": "Destination",
                    "kind": "optional",
                    "type": "string",
                    "description": "Id of the server",
                    "example": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
                    "default": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622"
                  },
                  {
                    "name": "Source",
                    "kind": "optional",
                    "type": "string",
                    "description": "User public key",
                    "example": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
                    "default": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355"
                  },
                  {
                    "name": "Time",
                    "kind": "optional",
                    "type": "string",
                    "description": "UTC Time of execution",
                    "example": "2021-02-14 09:58:52.320",
                    "default": "2021-02-14 09:58:52.320"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/getCashboxesResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url http://1.1.1.1/getCashboxes \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"Meta\": {\n     \"FunctionName\": \"getCashboxes\",\n     \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n     \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n     \"Time\": \"2021-02-07T18:37:46.948Z\",\n     \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n     \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n     }\n     }'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"Meta\": {\n      \"FunctionName\": \"getCashboxes\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"http://1.1.1.1/getCashboxes\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://1.1.1.1/getCashboxes\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"Meta\": {\n      \"FunctionName\": \"getCashboxes\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"http://1.1.1.1/getCashboxes\"\n\npayload = json.dumps({\n   \"Meta\": {\n      \"FunctionName\": \"getCashboxes\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// success\n{\n  \"FunctionData\": {\n    \"Cashboxes\": [\n      {\n        \"CashboxEthereumRealBalance\": \"null\",\n        \"CashboxRealBalance\": \"1000000\",\n        \"CashboxStatus\": 2,\n        \"CashboxDataSignedByCold\": {\n          \"Data\": {\n            \"AccountId\": 1,\n            \"CashboxAddress\": \"12bej8oZDE6gveXds5Ze8VjXHWvFTcLyyC\",\n            \"CashboxContactName\": \"Cashbox: BTC\",\n            \"CashboxCreationTime\": \"1627303305\",\n            \"CashboxId\": 31,\n            \"CashboxName\": \"CashboxName\",\n            \"CurrencySymbol\": \"BTC\",\n            \"GasLimit\": \"null\",\n            \"Parts\": 3,\n            \"Time\": \"2021-07-26 12:52:36.659\",\n            \"TotalAmount\": \"300000000\",\n            \"CashboxDestinations\": [\n              {\n                \"Address\": \"19Pxiuw1STqszL84kzyb2Jw5dFm541hyDd\",\n                \"DestinationIndex\": 0,\n                \"DestinationName\": \"Account Main Account: MPC\",\n                \"Protected\": \"True\"\n              }\n            ],\n            \"FeeOptions\": [\n              \"[1,2,3,4,5,6,7,8,9,10]\"\n            ],\n            \"UsersIds\": [\n              \"[\\\"bob@gk8.io\\\",\\\"alice@gk8.io\\\",\\\"david@gk8.io\\\"]\"\n            ]\n          }\n        }\n      }\n    ]\n  },\n  \"Meta\": {\n    \"AccessToken\": \"a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6\",\n    \"Destination\": \"042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622\",\n    \"Source\": \"df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355\",\n    \"Time\": \"2021-02-14 09:58:52.320\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "MQXw8rbZCNcILthc18uN-",
      "type": "paragraph",
      "children": [
        {
          "text": "param None",
          "id": "faJ2ql4gGTq9Jn-innJ1z"
        }
      ]
    },
    {
      "id": "gHt4GVyssxE-r3XNwU_82",
      "type": "bulleted-list",
      "children": [
        {
          "id": "4vPANJKrWbU2pomHPBazF",
          "type": "list-item",
          "children": [
            {
              "id": "SCSfwS4Hhc0UnzVTBYRVm",
              "type": "list-item-child",
              "children": [
                {
                  "text": "return - array containing all cashboxes associated with accounts that user can view",
                  "id": "Fvgc_YtzNaSU3WAk10lEq"
                },
                {
                  "text": "",
                  "id": "ZoFcB8KWDcFpjBFRubZhz"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}