...
Get a list of available users. Users can also be browsed by keywords, gender, age, and other profile fields
Example URI
Code Block | ||||
---|---|---|---|---|
| ||||
http://example.com/restful_api/user?page=1& |
...
limit=10 |
...
Parameters
Parameter | Type | Require ? | Description |
---|---|---|---|
page | number | no | Paging the result items |
limit | number | no | Limit the result items |
view | string | no | Options: recommend, recent |
searchgender | number | no | Specify the gender of searching users (gender id) |
searchfrom | number | no | Specify the minimum age of searching users |
searchto | number | no | Specify the maximum age of searching users |
searchcountry | string | no | Specify the country of searching users (country code) |
searchcountry_child_id | number | no | Specify the state/province of searching users (state id/ province id) |
searchzip | string | no | Specify the zip code of searching users |
searchcity | string | no | Specify the city of searching users |
searchkeyword | string | no | Search for users that contains this keyword in their name |
custom | array | no | Specify custom fields of searching users |
...
Register a user account
Example URI
Code Block | ||||
---|---|---|---|---|
| ||||
http://example.com/restful_api/user |
...
Parameters
Input fields base on site settings
...
Get information of a specific user by user id
Example URI
Code Block | ||||
---|---|---|---|---|
| ||||
http://example.com/restful_api/user/1 |
...
Parameters
Parameter | Type | Require ? | Description |
---|---|---|---|
id | number | yes | User id |
...
Update a specific user
Example URI
Code Block | ||||
---|---|---|---|---|
| ||||
http://example.com/restful_api/user/1 |
...
Parameters
Parameter | Type | Require ? | Description |
---|---|---|---|
id | number | yes | User Id |
val[email] | string | no | Email address |
val[user_name] | string | no | User name |
val[full_name] | string | no | Full name |
val[language_id] | string | no | Language id |
val[time_zone] | string | no | Timezone id |
val[default_currency] | string | no | Default currency |
val[city_location] | string | no | City location |
val[country_iso] | string | no | Country iso |
val[day] | number | no | Day of birth |
val[month] | number | no | Month of birth |
val[year] | number | no | Year of birth |
val[gender] | number | no | Gender id |
val[country_child_id] | number | no | State id or province id |
val[postal_code] | string | no | Postal code |
val[relation] | number | no | Relation id |
val[relation_with] | number | no | Id of user that have relation with this user |
val[password] | string | no | Update password |
val[delete_image] | number | no | Delete profile photo or not |
image | image file | no | Upload profile photo |
...
Delete a specific user
Example URI
Code Block | ||||
---|---|---|---|---|
| ||||
http://example.com/restful_api/user/2 |
...
Parameters
Parameter | Type | Require ? | Description |
---|---|---|---|
id | number | yes | User id |
...
Get custom fields information of a specific user by user id
Example URI
Code Block | ||||
---|---|---|---|---|
| ||||
http://example.com/restful_api/user/custom/1 |
...
Parameters
Parameter | Type | Require ? | Description |
---|---|---|---|
id | number | yes | User id |
...
Update custom fields values of a specific user
Example URI
Code Block | ||||
---|---|---|---|---|
| ||||
http://example.com/restful_api/user/custom/1 |
...
Parameters
Parameter | Type | Require ? | Description |
---|---|---|---|
id | number | yes | User Id |
custom | array | no | Custom fields values |
...