Get User Info by ID

The Get User Info by ID method allows to get user information by given user ID.

GET /api/vendor/v1/users/{id}.json?api_token={api_token}

Arguments

Name

Parameter Type

Data type

Required/
Optional

Description

id

path

integer

Required

A unique identification number of the user.

api_tokenquerystringRequiredAPI token of the manager who perform the operation (see API Token Authentication).

Response model

Name

Data type

Description

id

integer

A unique identification number of the user.

first_name

string

The first name of the user.

middle_name

string

The middle name of the user.

last_name

string

The last name of the user.

email

string

An email of the user, which is used as a login.

status

string

A user's status for all Accounts, to which it was linked: active or inactive.

custom_attributes

array

A list of additional attributes (see Managing attributes in the ActivePlatform. Operator Control Panel):

  • name - a name of the attribute;

  • value - a value of the attribute.

created_at

date

A date and time of the user creation.

updated_at

date

A date and time of the last update of the user information.

Request example

GET http://billing.activeplatform.com:80/api/vendor/v1/users/2000188?api_token=654321

Response example

{ 
 	"id": 2000132, 
 	"first_name": "John", 
 	"middle_name": "", 
 	"last_name": "Doe", 
 	"email": "john.doe@activeplatform.com", 
 	"status": "active", 
  "custom_attributes": [
   {
    "name": "Age",
    "value": "21"
   }
  	],
 	"created_at": "2015-01-12T22:32:25.104+03:00",
 	"updated_at": "2016-08-16T05:01:07.649+03:00"
 }