/api/reseller/users/{userId}/info

GET

/api/reseller/users/{userId}/info

curl --request GET \
  --url https://dashboard.residential.rayobyte.com/api/reseller/users/9ee3d294-6f1e-489c-9b9b-e25e9a4e37a8/info \
  --header 'Authorization: Bearer <token>'

• Main API host

Endpoint to obtain complete information about the account of one single Sub-user

Provides complete information about a single Proxy User owned by the Reseller. Available information includes the following fields: user ID, login (used to access proxy services), account status, traffic balance in kilobytes, total amount of traffic used in kilobytes, amount of traffic used for the last day, creation and last update dates, data on using traffic in a human-readable string form, as well as a temporary password set at the stage of creating a Sub-user by the Reseller.

Authorizations

• bearerAuth

Parameters

Path Parameters

userId

required

string

Proxy User ID

Example

9ee3d294-6f1e-489c-9b9b-e25e9a4e37a8

Responses

200

Success

Media typeapplication/json

object

status

string

Allowed values: SUCCESS

date

string

data

object

Examples

ExampleSuccess

Reseller info

{
  "status": "SUCCESS",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "data": {
    "id": "2",
    "userStatus": "ACTIVE",
    "accountType": "USER",
    "login": "test-user2-users",
    "email": "user1@gmail.com",
    "tempPssword": "12345",
    "description": "test user account 1",
    "created": "2022-01-19T17:54:43.000Z",
    "updated": "2022-01-19T17:54:43.000Z",
    "proxyUserStatus": "ACTIVE",
    "trafficBalanceKb": 5030000,
    "trafficConsumedKb": 15000,
    "trafficBalanceString": "4.8 GB",
    "trafficConsumedString": "14.6 MB"
  }
}

401

Not authorized

Media typetext/html

string

Examples

ExampleNot authorized

Not authorized

Not authorized.

500

API call failed

Media typeapplication/json

object

status

string

Allowed values: FAIL

date

string

error

string

Examples

ExampleInternal error

The user does not exist or belongs to other reseller

{
  "status": "FAIL",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "error": "Can not find user info"
}