My Profile

get
Get My Profile

https://api.playportal.io/user/v1/my/profile
Retrieves the playPORTAL profile of the logged in user.
Request
Response
Request
Headers
Authorization
required
string
Auth token generated via the OAuth login flow.
Response
200: OK
User profile retrieved.
{
handle: '@testkid-testerson1',
firstName: 'Kim',
lastName: 'Testerson',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c532daa6bc7c26d4da58790',
coverPhoto: '5c532daa6bc7c26d4da58791',
userId: 'c5e88a191da0b9b9f5ce2dfae5290df2728df9ae89bceab1756127e9ad20f8b9d429f9d3a06f4d011b1bfaa3660e8d275eb74c9ce7075926c627ed04d9735a11f097b7a92cbc85dc4a71b4126f439e497c$39195cc9f398d40c5c128c44fddf39c5',
parentFlags: { cameraDisabled: false, proximityFriends: false }
}

get
Get My Friends

https://api.playportal.io/user/v1/my/friends
Retrieves the playPORTAL profiles of the logged in users friends.
Request
Response
Request
Headers
Authorization
required
string
Auth token generated via the OAuth login flow.
Response
200: OK
User friends retrieved.
[
{
handle: '@testkid-testerman2',
firstName: 'Rachel',
lastName: 'Testerman',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c532e2da8f7b76d56d73669',
coverPhoto: '5c532e2da8f7b76d56d7366a',
userId: '4f7395ab0bf127088e27abc6da009ad46d45d46d41e0d1d745099845c07a47177938416673bea5d55cb9e32caf9cddffae2aea3224711c794583a089716072a05b5e46d2c8f9a67604136f21279a9cc1ac$1107f8967b65d027af29876590b78f8a',
anonymous: false,
parentFlags: { cameraDisabled: false, proximityFriends: false }
}, {
handle: '@testkid-testerman1',
firstName: 'Rachel',
lastName: 'Testerman',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c532e2da8f7b76d56d73669',
coverPhoto: '5c532e2da8f7b76d56d7366a',
userId: '4f7395ab0bf127088e27abc6da009ad46d45d46d41e0d1d045099845c07a47177938416673bea5d55cb9e32caf9cddffae2aea3224711c794583a089716072a05b5e46d2c8f9a67604136f21279a9cc1ac$1107f8967b65d027af29876590b78f8a',
anonymous: false,
parentFlags: { cameraDisabled: false, proximityFriends: false }
}
]

get
Get My Profile Picture

https://api.playportal.io/user/v1/my/profile/picture
Retrieves the image data of the logged in user's profile picture.
Request
Response
Request
Headers
Authorization
required
string
Auth token generated via the OAuth login flow.
Response
200: OK
User profile picture retrieved.
Base64 encoded JPG data.

get
Get My Cover Photo

https://api.playportal.io/user/v1/my/profile/cover
Retrieves the image data of the logged in user's cover photo.
Request
Response
Request
Headers
Authorization
required
string
Auth token generated via the OAuth login flow.
Response
200: OK
User cover photo retrieved.
Base64 encoded JPG data.

get
Get My Kids

https://api.playportal.io/user/v1/my/kids
Retrieves a list of the logged in user's kids.
Request
Response
Request
Headers
Authorization
required
string
Auth token generated via the OAuth login flow.
Response
200: OK
A list of the user's kids.
[ {
handle: '@testkid-testerson1',
firstName: 'Isabelle',
lastName: 'Testerson',
userType: 'child',
accountType: 'Kid',
country: 'US',
profilePic: '5c532f7adc3e016d604f9937',
coverPhoto: '5c532f7adc3e016d604f9938',
userId: '5f2393dfa33ca8b4fa23443b9a9a5123e88d27d2ac9490980b5c69c51a9a85e0a669906d4dfc302f17f31aee0a233a41d90419f281c4575882bdf2c0bf4e90c3c0cf6abec37738da128fcba40fcdd52eb2$23cbec6f3877ddf922f81f3533a00092',
anonymous: false,
parentFlags: { cameraDisabled: false, proximityFriends: false }
} ]

get
Get My Parents

https://api.playportal.io/user/v1/my/parents
Retrieves a list of the logged in user's parents/guardians.
Request
Response
Request
Headers
Authorization
required
string
Auth token generated via the OAuth login flow.
Response
200: OK
[ { handle: '@testmom-testerson',
firstName: 'Penny',
lastName: 'Testerson',
userType: 'adult',
accountType: 'Parent',
country: 'US',
profilePic: '5c533006f536ee6d729d5624',
coverPhoto: '5c533006f536ee6d729d5625',
userId: 'ecdea56a5544889ad212fcde4559d740920c16ab273ccba187c394ff5b210caf254e77decbac6fdb00fbd4b8dee544f7d0e661e7302f1cf31255d4ab0358a10f0e4f782d570e8b4b2edbe27dada0711420$755ba42d066f4bf0965379bd0d67618c',
anonymous: false } ]

put
Create Anonymous User

https://api.playportal.io/user/v1/my/profile
Creates an anonymous account, which can be used by an app in place of a full-fledged profile for users who have not gone through the playPORTAL signup flow. Note that if the app fails to refresh an anonymous user's session or logs them out in some way the user will have to create a new anonymous profile.
Request
Response
Request
Body Parameters
deviceToken
optional
string
An iOS device token or Android registration ID to use for push notifications for this user.
dateOfBirth
required
string
A date string representing the user's date of birth. This is required so we can create the appropriate type of account for the user.
clientId
required
string
Your app's client ID from playPORTAL Studio.
anonymous
required
boolean
Must be "true".
Response
200: OK
Returns the new user profile. A refresh token is returned in the request headers as "refresh_token", and an access (auth) token is return as "access_token".
{ handle: '@anon-774dec2b327e6fa73e5e36c00c9c7fbe35207ec8963fb94020f7bf667ad1e94c',
userType: 'teen-minor',
accountType: 'Adult',
country: 'US',
profilePic: null,
coverPhoto: null,
userId: '94aaa8e477bfe1330f68ebd4dfbd1a1c4bd2ed3fa21737db33ed93316e74e77a1704329ca1584d332b5b3efd9f2efaf4b788a1d1ccdbf307498e91ca3fb01ee6c117cf49f139b8aa49ae5406b1b39fbb2a$e51d20b8b1088fcb45b982f9aa19ddfa',
anonymous: true }