{"__v":10,"_id":"55fa3a948065a10d004e5bd5","category":{"__v":7,"_id":"55fa37ca8065a10d004e5bb7","pages":["55fa37ca8065a10d004e5bbb","55fa37ca8065a10d004e5bbc","55fa37ca8065a10d004e5bbd","55fa37ca8065a10d004e5bbe","55fa37ca8065a10d004e5bbf","55fa37ca8065a10d004e5bc0","55fa3a948065a10d004e5bd5","55fa3c3ba663c00d00773dce","55fa4b8eaba81f0d00a115e4","56733ae758c4890d00bb548a","56734f9c4b2a680d00524e09","569d8eae3dbdc20d005feee8"],"project":"54e405191e51932d006abc39","version":"55fa37c88065a10d004e5bb6","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-18T03:20:58.779Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"parentDoc":null,"project":"54e405191e51932d006abc39","user":"54e4044e8ef7552300409dcb","version":{"__v":7,"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["55fa37ca8065a10d004e5bb7","55fa37ca8065a10d004e5bb8","55fa37ca8065a10d004e5bb9","55fa37ca8065a10d004e5bba","55fca6bf34ae7c0d00ab8ea0","55ff80fd9e7ccf0d000a1d93","560220af7435de0d00fabd0d","56107f21bb9d920d00303e70","563e184077681a0d00d96a02","56fafc6596ec7e0e002ac85f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"updates":["56071f7b44789e0d0071211a","58d18b9c175dc22500e32882"],"next":{"pages":[],"description":""},"createdAt":"2015-09-17T03:59:16.458Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Following is a map of the entire API including all of the API calls that are supported and what you can do with each call.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"URL\",\n    \"h-1\": \"HTTP Verb\",\n    \"h-2\": \"Functionality\",\n    \"h-3\": \"Notes\",\n    \"2-0\": \"/users\",\n    \"2-1\": \"GET\",\n    \"2-2\": \"Get All Users\",\n    \"2-3\": \"View all users (paginated). Search by name and email available.\",\n    \"3-1\": \"POST\",\n    \"3-0\": \"/users\",\n    \"3-2\": \"Create User\",\n    \"3-3\": \"Allows you to register a new user to Synapse\",\n    \"4-0\": \"/users/<user:id>\",\n    \"4-1\": \"GET\",\n    \"4-2\": \"Get a User\",\n    \"4-3\": \"View user's details (paginated). Search by user type available.\",\n    \"5-0\": \"/users/<user:id>\",\n    \"5-1\": \"PATCH\",\n    \"5-2\": \"Update User Info\",\n    \"5-3\": \"Here is where all user identity KYC, preferences, etc. will be updated. You can also refresh access to the user.\",\n    \"6-0\": \"/users/<user:id>/nodes\",\n    \"6-1\": \"GET\",\n    \"6-2\": \"Get All User Nodes\",\n    \"6-3\": \"View all user nodes (paginated). Search by node type available.\",\n    \"7-0\": \"/users/<user:id>/nodes\",\n    \"7-1\": \"POST\",\n    \"7-2\": \"Create Node/ Do MFA\",\n    \"8-0\": \"/users/<user:id>/nodes/<node:id>\",\n    \"8-1\": \"GET\",\n    \"8-2\": \"Get Node Info\",\n    \"9-0\": \"/users/<user:id>/nodes/<node:id>\",\n    \"9-1\": \"PATCH\",\n    \"9-2\": \"Verify Micro Deposits\",\n    \"10-1\": \"DELETE\",\n    \"10-0\": \"/users/<user:id>/nodes/<node:id>\",\n    \"10-2\": \"Delete Node\",\n    \"10-3\": \"This does not actually delete the node, but removes it from indexing. GET will still reveal the node, but user will not show up in search.\",\n    \"11-0\": \"/users/<user:id>/nodes/<node:id>/trans\",\n    \"11-1\": \"GET\",\n    \"11-2\": \"Get All Transactions\",\n    \"11-3\": \"View all transactions of a user (paginated).\",\n    \"12-0\": \"/users/<user:id>/nodes/<node:id>/trans\",\n    \"12-1\": \"POST\",\n    \"12-2\": \"Create New Trans\",\n    \"13-0\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"13-1\": \"GET\",\n    \"13-2\": \"Get Transaction\",\n    \"14-0\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"14-1\": \"PATCH\",\n    \"14-2\": \"Update Status Note, Add Attachments\",\n    \"14-3\": \"Used to communicate with Synapse regarding queued transactions & adding transaction attachments.\",\n    \"15-0\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"15-1\": \"DELETE\",\n    \"15-2\": \"Cancel Transaction\",\n    \"15-3\": \"Only works if transaction has been created or queued.\",\n    \"7-3\": \"Add bank accounts, Synapse escrows or wire resources.\",\n    \"8-3\": \"View a node's details.\",\n    \"9-3\": \"Endpoint to verify micro-deposits upon adding a node via account/routing information.\",\n    \"12-3\": \"Send money from this user to another user.\",\n    \"13-3\": \"View a single transaction.\",\n    \"0-0\": \"/oauth/<user:id>\",\n    \"0-1\": \"POST\",\n    \"0-2\": \"Get User's Access Token\",\n    \"0-3\": \"This API call allows you to get access_tokens for users.\",\n    \"16-0\": \"/subscriptions\",\n    \"16-1\": \"GET\",\n    \"16-2\": \"Get All Subscriptions\",\n    \"16-3\": \"View all subscriptions of a gateway (paginated).\",\n    \"17-0\": \"/subscriptions\",\n    \"17-1\": \"POST\",\n    \"17-2\": \"Create New Subscription\",\n    \"17-3\": \"Create a subscription with webhook preferences.\",\n    \"18-0\": \"/subscriptions/<subscription:id>\",\n    \"18-1\": \"GET\",\n    \"18-2\": \"Get Subscription\",\n    \"18-3\": \"View a subscription.\",\n    \"19-0\": \"/subscriptions/<subscription:id>\",\n    \"19-1\": \"PATCH\",\n    \"19-2\": \"Update scope, url, is_active\",\n    \"19-3\": \"Update any information about a subscription.\",\n    \"1-0\": \"/oauth/<user:id>/login\",\n    \"1-1\": \"POST\",\n    \"1-2\": \"Get User's Refresh Token\"\n  },\n  \"cols\": 4,\n  \"rows\": 20\n}\n[/block]","excerpt":"Following is the Map of the API","slug":"api-map","type":"basic","title":"API Map"}

API Map

Following is the Map of the API

Following is a map of the entire API including all of the API calls that are supported and what you can do with each call. [block:parameters] { "data": { "h-0": "URL", "h-1": "HTTP Verb", "h-2": "Functionality", "h-3": "Notes", "2-0": "/users", "2-1": "GET", "2-2": "Get All Users", "2-3": "View all users (paginated). Search by name and email available.", "3-1": "POST", "3-0": "/users", "3-2": "Create User", "3-3": "Allows you to register a new user to Synapse", "4-0": "/users/<user:id>", "4-1": "GET", "4-2": "Get a User", "4-3": "View user's details (paginated). Search by user type available.", "5-0": "/users/<user:id>", "5-1": "PATCH", "5-2": "Update User Info", "5-3": "Here is where all user identity KYC, preferences, etc. will be updated. You can also refresh access to the user.", "6-0": "/users/<user:id>/nodes", "6-1": "GET", "6-2": "Get All User Nodes", "6-3": "View all user nodes (paginated). Search by node type available.", "7-0": "/users/<user:id>/nodes", "7-1": "POST", "7-2": "Create Node/ Do MFA", "8-0": "/users/<user:id>/nodes/<node:id>", "8-1": "GET", "8-2": "Get Node Info", "9-0": "/users/<user:id>/nodes/<node:id>", "9-1": "PATCH", "9-2": "Verify Micro Deposits", "10-1": "DELETE", "10-0": "/users/<user:id>/nodes/<node:id>", "10-2": "Delete Node", "10-3": "This does not actually delete the node, but removes it from indexing. GET will still reveal the node, but user will not show up in search.", "11-0": "/users/<user:id>/nodes/<node:id>/trans", "11-1": "GET", "11-2": "Get All Transactions", "11-3": "View all transactions of a user (paginated).", "12-0": "/users/<user:id>/nodes/<node:id>/trans", "12-1": "POST", "12-2": "Create New Trans", "13-0": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "13-1": "GET", "13-2": "Get Transaction", "14-0": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "14-1": "PATCH", "14-2": "Update Status Note, Add Attachments", "14-3": "Used to communicate with Synapse regarding queued transactions & adding transaction attachments.", "15-0": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "15-1": "DELETE", "15-2": "Cancel Transaction", "15-3": "Only works if transaction has been created or queued.", "7-3": "Add bank accounts, Synapse escrows or wire resources.", "8-3": "View a node's details.", "9-3": "Endpoint to verify micro-deposits upon adding a node via account/routing information.", "12-3": "Send money from this user to another user.", "13-3": "View a single transaction.", "0-0": "/oauth/<user:id>", "0-1": "POST", "0-2": "Get User's Access Token", "0-3": "This API call allows you to get access_tokens for users.", "16-0": "/subscriptions", "16-1": "GET", "16-2": "Get All Subscriptions", "16-3": "View all subscriptions of a gateway (paginated).", "17-0": "/subscriptions", "17-1": "POST", "17-2": "Create New Subscription", "17-3": "Create a subscription with webhook preferences.", "18-0": "/subscriptions/<subscription:id>", "18-1": "GET", "18-2": "Get Subscription", "18-3": "View a subscription.", "19-0": "/subscriptions/<subscription:id>", "19-1": "PATCH", "19-2": "Update scope, url, is_active", "19-3": "Update any information about a subscription.", "1-0": "/oauth/<user:id>/login", "1-1": "POST", "1-2": "Get User's Refresh Token" }, "cols": 4, "rows": 20 } [/block]