API

Common

Getting Started

User

Register New User
Login
Logout
Refresh Access Token
Get User Profile
Update Profile
Upload Avatar
Delete User
Reset Password
Reset Password by ID

User Token

List User Tokens
Add User Token
Update Default User Token
Delete User Token
Verify User Token
Reset Verification Code

User vAtom

Get vAtom
Get vAtoms by Ids
Get vAtom Inventory
Search vAtoms
Geo Discover Groups
Geo Discover vAtoms
Update vAtoms
Perform Action
Trash vAtom

User Activity

Get My Threads
Get My Thread Messages

Template

List Templates
Get Template
Create Template
Update Template
Delete Template

Template Variation

List Variations
Get Variation
Create Variation
Update Variation
Delete Variation

vAtom

Emit vAtom

Template Action

List Actions
Get Action
Register Action Handler
Register Action
Update Action
Delete Action

Template Face

List Faces
Register Face
Update Face
Delete Face

Asset

Upload Assets
Get Assets
Delete Assets

Get User Profile

GET
https://api.blockv.io/v1/user

Overview

This endpoint returns the current user profile.

Get Profile Request

HTTP Headers

Content-Type: application/x-www-form-urlencoded App-Id: {app_id}

Sample Request

Body intentionally left blank.

Get Profile Response

The endpoint will return the full user object for the current user.

Return & Error Codes

ErrorTypeDescription
200httpEverything is OK
403httpNot Authorized

payload Object

NameTypeDescription
idstringThe user's unique identifier, a 36 character UUID.
metaobjectThe object's meta information (for example the creation timestamp).
propertiesobjectThe properties of the object.
system_propertiesobjectAn additional set of properties that cannot be changed by the user.

properties Object

NameTypeDescription
first_namestringThe user's first name.
last_namestringThe user's last name.
name_publicbooleanFlag to indicate if other users can see the user's first and last name.
avatar_uristringA URI to the user's avatar.
avatar_publicbooleanFlag to indicate if other users can see the user's avatar.
birthdaystringThe user's birth date.
languagestringThe user's preferred language.

system_properties Object

NameTypeDescription
is_adminbooleanFlag to indicate if a user is a publisher admin.
activatedbooleanIs set to true if at least one user token was verified. Actions can be configured to allow only activated users to execute them.
last_loginstringTimestamp of the last login.
is_merchantbooleanIs set to true in case the user can redeem vAtoms of other users and hence is a merchant.

Sample Response

{
    "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,
        }
    }
}
©2020 BLOCKv
Info