{"_id":"56951b250c650a2300250544","category":{"_id":"5692b19ffe72e00d00e4f0a8","__v":10,"pages":["5692b1ec72d4580d0081e96b","5692b39b72d4580d0081e96f","56951b250c650a2300250544","569520590c650a2300250553","56952277caa32519009c410a","569523782e5eb41700901a7e","56992a43de42370d00727c7c","56b8acb443bbd10d0081d148","56ec413636bc8e0e00f190e3","56ec46068fac371700005d12"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-10T19:31:43.021Z","from_sync":false,"order":12,"slug":"fix-api","title":"Users"},"editedParams2":true,"parentDoc":null,"user":"563cc6fa8894d20d00014ea3","editedParams":true,"version":{"_id":"563cc7119799fb0d00047688","__v":17,"project":"563cc7119799fb0d00047685","createdAt":"2015-11-06T15:28:17.683Z","releaseDate":"2015-11-06T15:28:17.683Z","categories":["563cc7129799fb0d00047689","566f37f37ffa002300c3cd5b","56914e9bd47b020d002225ac","5692b19ffe72e00d00e4f0a8","56940bc2d8c04d1700e5adb6","56940bc83e9d080d00f064f0","56951b2dfcb1032d0089df7a","569522aecaa32519009c410c","569523ce562335190016da97","569523fddcaf0d1700cb86bf","56980e4a8560a60d00e2c3c3","569921a41693520d002e1305","5699323b7465970d00650b82","569e6cc4fbee990d0072d927","56a2768a0aefae0d00b7fe66","5862e862b8b7fa23009665b7","592835c7bc8bca0f000cc9ff"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"__v":1,"project":"563cc7119799fb0d00047685","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T15:26:29.943Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET /v1/users/02e57c7d-d071-4c63-b491-1194a9939ea5/ HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json\nx-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z","language":"http"},{"code":"curl -X GET -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"x-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\" 'https://api.drivewealth.io/v1/users/02e57c7d-d071-4c63-b491-1194a9939ea5/'","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"ackSignedWhen\": \"2016-01-11T21:43:34.366Z\",\n    \"addressLine1\": \"123 Main St\",\n    \"avatarUrl\": \"https://secure.gravatar.com/avatar/56caae686cf14b8b82e0001f31461fbd.jpg\",\n    \"city\": \"Wicker\",\n    \"coinBalance\": 0,\n    \"commissionRate\": 2.99,\n    \"countryID\": \"USA\",\n    \"displayName\": \"BBelcher\",\n    \"emailAddress1\": \"bob:::at:::burgers.com\",\n    \"firstName\": \"Bob\",\n    \"gender\": \"male\",\n    \"languageID\": \"en_US\",\n    \"lastName\": \"Belcher\",\n    \"phoneHome\": \"(201) 345-2206\",\n    \"referralCode\": \"VL7FN4\",\n    \"sessionKey\": \"02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\",\n    \"stateProvince\": \"NJ\",\n    \"userID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"username\": \"bobbelcher37\",\n    \"wlpID\": \"DW\",\n    \"zipPostalCode\": \"08332\",\n    \"status\": 2,\n    \"usCitizen\": false,\n    \"updatedWhen\": \"2016-01-13T15:58:00.582Z\",\n    \"lastLoginWhen\": \"2016-01-13T22:34:53.225Z\",\n    \"rebateCfdValue\": 0,\n    \"rebateEquityValue\": 0,\n    \"rebateFxValue\": 0,\n    \"brandAmbassador\": false,\n    \"employerBusiness\": \"Food and Beverage\",\n    \"employmentStatus\": \"Employed / Self-Employed\",\n    \"statementPrint\": false,\n    \"confirmPrint\": false,\n    \"citizenship\": \"USA\",\n    \"createdWhen\": \"2016-01-11T21:38:40.103Z\",\n    \"addressProofReviewWhen\": \"2016-01-11T21:44:36.603Z\",\n    \"approvedWhen\": \"2016-01-11T21:45:00.131Z\",\n    \"approvedBy\": \"ca937083-48fe-4f47-9724-7fee515b08d6\",\n    \"kycWhen\": \"2016-01-11T21:44:42.188Z\",\n    \"pictureReviewBy\": \"ca937083-48fe-4f47-9724-7fee515b08d6\",\n    \"pictureReviewWhen\": \"2016-01-11T21:44:38.665Z\",\n    \"annualIncome\": \"$0 - $99,999\",\n    \"userAttributes\": \"{}\"\n}","language":"json","status":200},{"name":"","code":"{\n  \"code\": 404,\n  \"message\": \"User not found [userID=02e57c7d-d071-4c63-b491-1194a9939ea52]\"\n}","language":"json","status":404}]},"settings":"","auth":"required","params":[{"_id":"5696680bcb14e11700f8a972","ref":"","in":"path","required":true,"desc":"User ID.","default":"02e57c7d-d071-4c63-b491-1194a9939ea5","type":"string","name":"userID"}],"url":"/users/:userID"},"isReference":true,"order":1,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns a single user object. Every user has a default list of attributes.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`commissionRate`\",\n    \"0-1\": \"Commission rate.\",\n    \"1-0\": \"`emailAddress1`\",\n    \"2-0\": \"`languageID`\",\n    \"3-0\": \"`referralCode`\",\n    \"4-0\": \"`sessionKey`\",\n    \"5-0\": \"`username`\",\n    \"6-0\": \"`wlpID`\",\n    \"7-0\": \"`status`\",\n    \"8-0\": \"`lastLoginWhen`\",\n    \"1-1\": \"Email address.\",\n    \"2-1\": \"Language.<br />**Options**: `\\\"en_US\\\"` (Default), `\\\"zh_CN\\\"`, `\\\"es_ES\\\"`, `\\\"pt_BR\\\"` or `\\\"ja_JP\\\"`.\",\n    \"3-1\": \"Referral code to be used if user is referring a new client.\",\n    \"4-1\": \"Current session key.\",\n    \"5-1\": \"Username.\",\n    \"6-1\": \"White label partner ID.\",\n    \"7-1\": \"User status.\",\n    \"8-1\": \"The last time a user logged in via REST API.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]","excerpt":"Provides details on a specific user.","slug":"get-user","type":"endpoint","title":"Get User"}

getGet User

Provides details on a specific user.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

userID:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5
User ID.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns a single user object. Every user has a default list of attributes. [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`commissionRate`", "0-1": "Commission rate.", "1-0": "`emailAddress1`", "2-0": "`languageID`", "3-0": "`referralCode`", "4-0": "`sessionKey`", "5-0": "`username`", "6-0": "`wlpID`", "7-0": "`status`", "8-0": "`lastLoginWhen`", "1-1": "Email address.", "2-1": "Language.<br />**Options**: `\"en_US\"` (Default), `\"zh_CN\"`, `\"es_ES\"`, `\"pt_BR\"` or `\"ja_JP\"`.", "3-1": "Referral code to be used if user is referring a new client.", "4-1": "Current session key.", "5-1": "Username.", "6-1": "White label partner ID.", "7-1": "User status.", "8-1": "The last time a user logged in via REST API." }, "cols": 2, "rows": 9 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}