Get Account Information

Get information about an account:
GET /accounts/{aname}

Returns information about a specified account.


Request Components

HTTP Request


Resource and Query Parameters

You must include the account name in the path.

Parameter Name Data Type Description
string The name of the account for which you want information. An account name is usually numeric, and must include any leading zeros.

Header Parameters

The request header must contain the current session token.

Parameter Name Data Type Description
string A valid session token returned by POST /session/login.

Request Body


Success Responses

Status 200

A successful request returns the following account information:

Parameter Name Data Type Description
accountName string The name of the account.
accountNumber string The billing number of the account.
organizationName string The name of the organization that the account is part of.
isProvisioningAllowed boolean True if devices can be added to the account and activated with a single request. False if devices must be added to the account before they can be activated.
carriers array The names of all carriers for the account.
features array The names of features that are enabled for the account.
ipPools array Array of IP pools that are available to the account.
string The name of the IP pool.
string The type of IP pool, such as “Static IP” or “Dynamic IP.”
Boolean True if this is the default IP pool for the account.
servicePlans array Array of service plans that are available to the account.
string The service plan name.
string The service plan code, used when adding devices or changing device service plans.
string The amount of data included in the service plan.
string Internal service plan reference code.
string Any extended attributes for the service plan.

Example Success Response

    "Verizon Wireless"
    "Static IP",
    "Dynamic IP",
    "Customer PN"
      "poolType":"Static IP",
      "poolType":"Dynamic IP",

Failure Responses

Status 400

All error messages are returned in this format:

  "errorCode": "error code string",
  "errorMessage": "error message string"

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!