Get User and Friend Info
Retrieves user profile information and friend list.
URI Fragment
/people/{-list|,|userId}/{groupId}
/people/{-list|,|userId}/{groupId}/{-list|,|personId}
Parameter Name |
Type |
Description |
|---|---|---|
userId |
String or Number |
Use "@me" for current user, or direct numeric user ID. |
groupId |
String |
Either of "@self", "@all" or "@friends". "@all" and "@friends" have the same effect on results. |
persionId |
Number |
User IDs of the users that you want to check friend relationship against. See below example. |
Supported Signing Methods
Client Only Signing, 3-legged Authorization Signing
 | Please refer here for the details of authentication flow and here for how to sign request to generate the Authorization header. |
HTTP Method
GET
Request Header
- The Authorization header is necessary for this call to succeed.
URL Query Parameters
Parameter Name |
Type |
Description |
Required |
|---|---|---|---|
fields |
Array |
A list of fields to return. |
No |
format |
String |
Currently only "json" can be used. |
No |
filterBy |
Array |
The specifiable fields are "id" and "hasApp". |
No |
filterOp |
Array |
Currently only "equals" can be used. |
No |
filterValue |
Array |
The values for filter keys. |
No |
count |
Number |
Integer from 1-1000. Default is 50. |
No |
sortBy |
String |
Currently only "id" can be used. |
No |
sortOrder |
String |
"ascending" or "descending" |
No |
startIndex |
Number |
An integer starting from 1. |
No |
Request Body
None.
Response Status Code
HTTP Status Code |
HTTP Status Message |
Meaning |
|---|---|---|
200 |
OK |
Data successfully acquired |
400 |
Bad Request |
Corrupt request data on the client side |
401 |
Unauthorized |
Authorization error |
403 |
Forbidden |
The resource exists, but access is not possible due to a reason other than an authorization error. |
404 |
Not Found |
The resource does not exist. |
500 |
Internal Server Error |
An error on the API server side |
503 |
Service Unavailable |
The API cannot be used temporarily |
Response Body
- A single or a collection of user profiles.
- Content-Type: application/json; charset=utf-8
Parameter Name |
Type |
Description |
|---|---|---|
aboutMe |
String |
Introductory text about the user. |
addresses |
String |
Where the user lives (name of prefecture). |
age |
Number |
The user's age. Note: On the JP platform, if the user has not provided a birthday, or if the user's birthday is not public, this field is never returned. |
birthday |
Date |
The user's birthday. Note: On the JP platform, if a user has not provided a birthday, or if the user's birthday is not public, this field contains the value 0000-MM-DD. The month and date indicate when the account was created. |
bloodType |
String |
The user's blood type. |
displayName |
String |
The user's display name (same value as nickname). |
gender |
String |
The user's gender. Note: On the JP platform, this field contains the value undisclosed for users that have not set their gender. |
grade |
Number |
The type of Mobage account. See About User Grade. |
hasApp |
Boolean |
Whether or not the user has installed the current application. |
id |
UserId |
The user's ID value. |
interests |
String |
The user's interests. |
isFamous |
Boolean |
Special celebrity account with several limitations. |
On the JP platform, some legacy Mobage users are "celebrity accounts" that are used for promotional purposes. These accounts do not represent actual users, and they cannot receive any of the following notifications:
- Invitations to try the current app
- Mini-mail
- Remote notifications
Before sending any of these notifications to a user, check the user's isFamous flag and verify that the user is not a celebrity account.
On other Mobage platforms, the isFamous flag is currently always set to false.|isVerified
Boolean
Indicates whether SMS phone verification was performed when the account was created.
jobType
String
The user's occupation.
nickname
String
The user's nickname.
thumbnailUrl
String
The URL for the user's thumbnail image.
Example Request & Response
Retrieving user profile of the current user (3-legged Authorization Signing):
Retrieving user profiles of specific users (Consumer Only Signing):
Retrieving list of friends for the current user (3-legged Authorization Signing):