{"_id":"53ff936c23a37e1d5cebafc7","editedParams2":true,"parentDoc":null,"project":"53fe6dc5addab8973c1af267","__v":0,"category":{"_id":"53fe836faddab8973c1af2ce","__v":4,"version":"53fe6dc5addab8973c1af26a","pages":["53fe84c8addab8973c1af2d4","53ff936c23a37e1d5cebafc7","53ff947e23a37e1d5cebafca","55b27b2788093a21008bef06"],"project":"53fe6dc5addab8973c1af267","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-08-28T01:18:39.777Z","from_sync":false,"order":3,"slug":"api-reference","title":"API Reference"},"is_link":false,"version":{"_id":"53fe6dc5addab8973c1af26a","__v":19,"project":"53fe6dc5addab8973c1af267","createdAt":"2014-08-27T23:46:13.941Z","releaseDate":"2014-08-27T23:46:13.941Z","categories":["53fe6dc5addab8973c1af26b","53fe71a2addab8973c1af276","53fe7d89addab8973c1af2b0","53fe7d8daddab8973c1af2b1","53fe836faddab8973c1af2ce","53ff9a4823a37e1d5cebafe1","53ff9e3723a37e1d5cebaff7","53ffaca523a37e1d5cebb039","53ffad2e23a37e1d5cebb03c","5400c7d2ec93b29b61d4f7be","5400f0e1ec93b29b61d4f7dd","54d5636323010a0d001aca81","54d565c1276f8e0d00feab54","54ff40532882a10d00546927","556606d25561af0d008208b7","558c91900b236c2500d37c9a","56180a14f8c9632100ac7599","564fb3a59b4fab1700187518","5702e2d2f2d6f336005e901f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"editedParams":true,"user":"53fe6d8baddab8973c1af266","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-08-28T20:39:08.215Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","settings":"","try":false,"basic_auth":false,"examples":{"codes":[]},"results":{"codes":[{"name":"Success","code":"{\n  info: {\n    id: '12345',\n    first_name: 'Jesse',\n    last_name: 'Pollak',\n    phone_number: '1234567890',\n    email: 'jesse:::at:::getclef.com'\n  },\n  success: true\n}","language":"json","status":200},{"status":403,"name":"Failure","code":"{\n    error: 'Invalid token.'\n}","language":"json"}]},"auth":"never","params":[{"_id":"53ff936c23a37e1d5cebafc8","ref":"","in":"query","required":false,"desc":"The OAuth access token you received from the authorize handshake","default":"","type":"string","name":"access_token"}],"url":"/info"},"isReference":false,"order":1,"body":"Use the `/info` route to exchange an OAuth access token for a user's information. Primarily, you'll need the Clef `id`, so you can uniquely associate their Clef account to their user account in your system.","excerpt":"Exchange","slug":"apiv1info","type":"endpoint","title":"/api/v1/info"}

get/api/v1/info

Exchange

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

access_token:
string
The OAuth access token you received from the authorize handshake

Result Format


Documentation

Use the `/info` route to exchange an OAuth access token for a user's information. Primarily, you'll need the Clef `id`, so you can uniquely associate their Clef account to their user account in your system.

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 }}