Get Account's Users by the Account ID

The Get Account’s Users by Account ID method returns the List of Users, which have been attached to given Account.

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

Arguments

Name

Parameter Type

Data type

Required/Optional

Description

id

path

integer

Required

An account ID.

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

Response model

Name

Data type

Description

id

integer

An account ID.

first_name

string

The first name for the user the owner access rights.

middle_name

string

The middle name for the user the owner access rights.

last_name

string

The last name for the user the owner access rights.

email

string

A contact email of the account.

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's creation.

updated_at

date

A date and time, when the account information was updated.

Request example

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

Response example

[
  {
    "id": 2000290,
    "first_name": "John",
    "middle_name": "",
    "last_name": "Doe",
    "email": "john.doe@activeplatfrom.com",
    "status": "inactive",
    "custom_attributes": [],
    "created_at": "2015-02-05T13:05:01.147+03:00",
    "updated_at": "2015-08-17T14:41:03.219+03:00"
  }
]