Retrieve a User (REST)

GET <baseurl>/api/v1/users/<id>

This is the API equivalent of disp = user.

Response

Name

Type

Description

integer

User ID

picture

string

URL of main user profile picture

pictures

array

Array of URLs of other user profile pictures

string

firstname

string

First name

lastname

string

Last name

gender

string/null

'M' - Male, 'F' - Female, 'O' - Other, null - no gender

location

array

Key

Value

country

null OR array:

Key	Type	Value
id	integer	Country ID
name	string	Country name

region

null OR array:

Key	Type	Value
id	integer	Region ID
name	string	Region name

subregion

null OR array:

Key	Type	Value
id	integer	Sub-region ID
name	string	Sub-region name

city

null OR array:

Key	Type	Value
id	integer	City ID
name	string	City name

organizations

array

Array of user organizations, each array item is array:

Key	Type	Value
name	string	Organization name
url	string	Organization URL

userfields

array

Array of userfields, each array item is a grouped array with key as userfield group name:

Key	Type	Value
code	string	Userfield code
name	string	Userfield name
value	string	Userfield value

Errors

Possible Error Codes
Error code	HTTP response	Message
no_access	403	You must log in to view this user profile.
no_access	403	You must activate your account before you can view this user profile.
no_access	403	Your account status currently does not permit to view this user profile.
no_access	403	The requested user does not exist!
no_access	403	The requested user account is closed!
no_access	403	Please specify your country before attempting to contact other users.
no_access	403	You don’t have permission to view this user profile.
user_invalid_id	404	Invalid user ID

Created by • Last edit by on 2018-10-12 10:47 • •

Retrieve a User (REST)

Response

Errors

No feedback yet

About b2evolution

Downloads

About us

Webhosting Guide

Docs & Support

Other

Stay in touch