{"_id":"5c3e8416387b7b004b8a142e","project":"59f79e3c584eb200345ceafc","version":{"_id":"5ba178b00a916500030c6a21","project":"59f79e3c584eb200345ceafc","__v":25,"forked_from":"59f79e3c584eb200345ceaff","createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["5ba178b00a916500030c69a2","5ba178b00a916500030c69a3","5ba178b00a916500030c69a4","5ba178b00a916500030c69a5","5ba178b00a916500030c69a6","5ba178b00a916500030c69a7","5ba178b00a916500030c69a8","5ba178b00a916500030c69a9","5ba178b00a916500030c69aa","5ba178b00a916500030c69ab","5ba178b00a916500030c69ac","5afb6888212c690003ae3d3b","5ba178b00a916500030c69ad","5ba178b00a916500030c69ae","5ba2dcbc99f53f0003b97e2c","5babd73fa0ab3e0003ead030","5bb4038be7222e000334dd97","5bb55954478c1300031a44c2","5bb665a1607307000327c81e","5bb6f90229a7fb0003a0650d","5bb7f9bc29a7fb0003a07ac1","5bba58bd7ba7710003bd901d","5bba6dac7ba7710003bd908d","5bba6e257ba7710003bd9090","5bbac87810189c0003e619ea","5bbb9d02b5862c00036266b2","5bbbadb6219c3e000376c2de","5bc417751d1b0000182bf7f6","5bc59e3b2a5b4f0044db5b97","5bc7bbce2262cc0041f6eff2","5bce6a3580a7250031199f34","5bcfac2c4082510019f2d91b","5bcfac3757bed90030e45d68","5bcfac45d305bc0049941539","5bd2a43548bb6f00289c8fad","5bd3a42a026ebe001f66259e","5bd9d5afffe003005b02f97b","5becb7ee85c6b300557662b6","5c5b12896f30e0004b3c8066"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.1.0","version":"3.1"},"category":{"_id":"5bcfac2c4082510019f2d91b","project":"59f79e3c584eb200345ceafc","version":"5ba178b00a916500030c6a21","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-10-23T23:18:04.606Z","from_sync":false,"order":24,"slug":"node-resources","title":"Node Resources"},"user":"5c392fde03fb7d00454c69ed","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-16T01:08:38.078Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"##API ENDPOINT\nhttps://uat-api.synapsefi.com/v3.1/users/:user_id/nodes\n\n##PATH PARAMETER\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"> <div class=\\\"param-table\\\"> <div class=\\\"table\\\"> <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>user_id <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>ID of user</p></div></div></div></div></div></div>\"\n}\n[/block]\n##QUERY PARAMETER\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"> <div class=\\\"param-table\\\"> <div class=\\\"table\\\"> <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>page <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">integer</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Page number</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>per_page <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">integer</strong> <span class=\\\"param-default text-muted\\\">20</span> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Number of nodes per page</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>type <span class=\\\"colon\\\">:</span> </strong> </div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Type of nodes you wish to see. SYNAPSE-US, ACH-US, etc.</p></div></div></div></div></div></div>\"\n}\n[/block]\n##EXAMPLE REQUEST\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc\\nContent-Type: application/json\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"user.get_all_nodes(page=4, per_page=10, type='DEPOSIT-US')\",\n      \"language\": \"python\"\n    },\n    {\n      \"code\": \"user.getAllUserNodes();\",\n      \"language\": \"javascript\",\n      \"name\": \"Node.js\"\n    },\n    {\n      \"code\": \"user.get_all_nodes()\",\n      \"language\": \"ruby\"\n    },\n    {\n      \"code\": \"$page = 1;\\n$per_page = 1;\\n$type = 'DEPOSIT-US';\\n\\n$user->get_all_nodes($page , $per_page , $type);\",\n      \"language\": \"php\"\n    },\n    {\n      \"code\": \"data, err := user.GetNodes()\",\n      \"language\": \"go\"\n    }\n  ]\n}\n[/block]\n##EXAMPLE RESPONSE\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"error_code\\\": \\\"0\\\",\\n    \\\"http_code\\\": \\\"200\\\",\\n    \\\"limit\\\": 20,\\n    \\\"node_count\\\": 5,\\n    \\\"nodes\\\": [\\n        {\\n            \\\"_id\\\": \\\"594e5c694d1d62002f17e3dc\\\",\\n            \\\"_links\\\": {\\n                \\\"self\\\": {\\n                    \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e5c694d1d62002f17e3dc\\\"\\n                }\\n            },\\n            \\\"allowed\\\": \\\"CREDIT-AND-DEBIT\\\",\\n            \\\"client\\\": {\\n                \\\"id\\\": \\\"589acd9ecb3cd400fa75ac06\\\",\\n                \\\"name\\\": \\\"SynapseFI\\\"\\n            },\\n            \\\"extra\\\": {\\n                \\\"other\\\": {},\\n                \\\"supp_id\\\": \\\"ABC124\\\"\\n            },\\n            \\\"info\\\": {\\n                \\\"account_num\\\": \\\"7443\\\",\\n                \\\"address\\\": \\\"PLACE DE LA REPUBLIQUE 4 CROIX 59170 FR\\\",\\n                \\\"balance\\\": {\\n                    \\\"amount\\\": \\\"0.00\\\",\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"bank_long_name\\\": \\\"3 SUISSES INTERNATIONAL\\\",\\n                \\\"bank_name\\\": \\\"3 SUISSES INTERNATIONAL\\\",\\n                \\\"name_on_account\\\": \\\" \\\",\\n                \\\"nickname\\\": \\\"Some Account\\\"\\n            },\\n            \\\"is_active\\\": true,\\n            \\\"timeline\\\": [\\n                {\\n                    \\\"date\\\": 1498307689471,\\n                    \\\"note\\\": \\\"Node created.\\\"\\n                },\\n                {\\n                    \\\"date\\\": 1498307690130,\\n                    \\\"note\\\": \\\"Unable to send micro deposits as node type is not ACH-US.\\\"\\n                }\\n            ],\\n            \\\"type\\\": \\\"WIRE-INT\\\",\\n            \\\"user_id\\\": \\\"594e0fa2838454002ea317a0\\\"\\n        },\\n        {\\n        \\t...\\n        },\\n        {\\n        \\t...\\n        },\\n        ...\\n    ],\\n    \\\"page\\\": 1,\\n    \\\"page_count\\\": 1,\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n##PAGINATION\nResponses are paginated, so to move through pages, add `page` as a GET parameter. Here is an example request.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v3.1/users/594e0fa2838454002ea317a0/nodes?page=2 HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc\\nContent-Type: application/json\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"view-all-user-nodes","type":"basic","title":"View All User Nodes"}

View All User Nodes


##API ENDPOINT https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes ##PATH PARAMETER [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>user_id <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>ID of user</p></div></div></div></div></div></div>" } [/block] ##QUERY PARAMETER [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>page <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">integer</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Page number</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>per_page <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">integer</strong> <span class=\"param-default text-muted\">20</span> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Number of nodes per page</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong>type <span class=\"colon\">:</span> </strong> </div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Type of nodes you wish to see. SYNAPSE-US, ACH-US, etc.</p></div></div></div></div></div></div>" } [/block] ##EXAMPLE REQUEST [block:code] { "codes": [ { "code": "GET /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json", "language": "http" }, { "code": "user.get_all_nodes(page=4, per_page=10, type='DEPOSIT-US')", "language": "python" }, { "code": "user.getAllUserNodes();", "language": "javascript", "name": "Node.js" }, { "code": "user.get_all_nodes()", "language": "ruby" }, { "code": "$page = 1;\n$per_page = 1;\n$type = 'DEPOSIT-US';\n\n$user->get_all_nodes($page , $per_page , $type);", "language": "php" }, { "code": "data, err := user.GetNodes()", "language": "go" } ] } [/block] ##EXAMPLE RESPONSE [block:code] { "codes": [ { "code": "{\n \"error_code\": \"0\",\n \"http_code\": \"200\",\n \"limit\": 20,\n \"node_count\": 5,\n \"nodes\": [\n {\n \"_id\": \"594e5c694d1d62002f17e3dc\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e5c694d1d62002f17e3dc\"\n }\n },\n \"allowed\": \"CREDIT-AND-DEBIT\",\n \"client\": {\n \"id\": \"589acd9ecb3cd400fa75ac06\",\n \"name\": \"SynapseFI\"\n },\n \"extra\": {\n \"other\": {},\n \"supp_id\": \"ABC124\"\n },\n \"info\": {\n \"account_num\": \"7443\",\n \"address\": \"PLACE DE LA REPUBLIQUE 4 CROIX 59170 FR\",\n \"balance\": {\n \"amount\": \"0.00\",\n \"currency\": \"USD\"\n },\n \"bank_long_name\": \"3 SUISSES INTERNATIONAL\",\n \"bank_name\": \"3 SUISSES INTERNATIONAL\",\n \"name_on_account\": \" \",\n \"nickname\": \"Some Account\"\n },\n \"is_active\": true,\n \"timeline\": [\n {\n \"date\": 1498307689471,\n \"note\": \"Node created.\"\n },\n {\n \"date\": 1498307690130,\n \"note\": \"Unable to send micro deposits as node type is not ACH-US.\"\n }\n ],\n \"type\": \"WIRE-INT\",\n \"user_id\": \"594e0fa2838454002ea317a0\"\n },\n {\n \t...\n },\n {\n \t...\n },\n ...\n ],\n \"page\": 1,\n \"page_count\": 1,\n \"success\": true\n}", "language": "json" } ] } [/block] ##PAGINATION Responses are paginated, so to move through pages, add `page` as a GET parameter. Here is an example request. [block:code] { "codes": [ { "code": "GET /v3.1/users/594e0fa2838454002ea317a0/nodes?page=2 HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json", "language": "http" } ] } [/block]