GET
https://api.blockv.io/v1/userOverview
This endpoint returns the current user profile.
Get Profile Request
HTTP Headers
application/x-www-form-urlencoded
{app_id}
Body intentionally left blank.
Get Profile Response
The endpoint will return the full user object for the current user.
Return & Error Codes
Error | Type | Description |
---|
200 | http | Everything is OK |
403 | http | Not Authorized |
payload Object
Name | Type | Description |
---|
id | string | The user's unique identifier, a 36 character UUID. |
meta | object | The object's meta information (for example the creation timestamp). |
properties | object | The properties of the object. |
system_properties | object | An additional set of properties that cannot be changed by the user. |
properties Object
Name | Type | Description |
---|
first_name | string | The user's first name. |
last_name | string | The user's last name. |
name_public | boolean | Flag to indicate if other users can see the user's first and last name. |
avatar_uri | string | A URI to the user's avatar. |
avatar_public | boolean | Flag to indicate if other users can see the user's avatar. |
birthday | string | The user's birth date. |
language | string | The user's preferred language. |
system_properties Object
Name | Type | Description |
---|
is_admin | boolean | Flag to indicate if a user is a publisher admin. |
activated | boolean | Is set to true if at least one user token was verified. Actions can be configured to allow only activated users to execute them. |
last_login | string | Timestamp of the last login. |
is_merchant | boolean | Is set to true in case the user can redeem vAtoms of other users and hence is a merchant. |
{
"payload": {
"id": "001d0933-88e6-4e17-b147-0f672dc016d1",
"meta": {
"data_type": "blockv::user",
"when_created": "2018-01-01T00:00:00+00:00",
"when_modified": "2018-01-01T00:00:00+00:00"
},
"properties": {
"first_name": "John",
"last_name": "Doe",
"name_public": false,
"avatar_uri": "http://example.com/mypic.jpg",
"avatar_public": false,
"birthday": "1970-01-01",
"nonpush_notification": false,
"language": "en"
},
"system_properties": {
"pub_fqdn": "publisher_fqdn",
"is_admin": false,
"activated": false,
"last_login": "2018-01-01T00:00:00+00:00",
"is_merchant": false,
}
}
}