API Reference
# Get information about an account `GET /accounts/{accountname}` ### Uses and Requirements Returns information about a specified account. ### Request Components HTTP Request: GET https://thingspace.verizon.com/api/m2m/v1/accounts/{accountname} ### Resource Path and Query Parameters Resource Path and Query Parameters You must include the account name in the path. | Parameter Name | Data Type | Description | |:---------------------:|:---------:|:---------------------------------------------------------------------------------------------------------------------------------------------------:| | accountname required | string | The name of the account for which you want a list of states and services. An account name is usually numeric, and must include any leading zeros. | ### Header Parameters The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON. | Parameter Name | Data Type | Description | |:-----------------------:|:---------:|:------------------------------------------------------:| | Authorization required | string | HTTP Authorization bearer token. | | VZ-M2M-Token required | string | A valid session token returned by POST /session/login. | | Content-Type required | string | Must be application/json. | ### Request Body None. ### Success Responses Status 200 A successful request returns an array of engagements. Each engagement includes an array of custom services, and each service includes an array of custom states: Status 200 | 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. | | poolName | string | The name of the IP pool. | | poolType | string | The type of IP pool, such as “Static IP” or “Dynamic IP.” | | isDefaultPool | Boolean | True if this is the default IP pool for the account. | | servicePlans | array | Array of service plans that are available to the account. | | name | string | The service plan name. | | code | string | The service plan code, used when adding devices or changing device service plans. | | sizeKb | string | The amount of data included in the service plan. | | carrierServicePlanCode | string | Internal service plan reference code. | | extendedAttributes | string | Any extended attributes for the service plan. | ### Example Success Response ```json { "accountName":"Chintan_CPNStaticBulk", "accountNumber":"1234567890-77777", "organizationName":"ChintanCPNBulk", "isProvisioningAllowed":true, "carriers":[ "Verizon Wireless" ], "features":[ "Static IP", "Dynamic IP", "Customer PN" ], "ipPools":[ { "poolName":"ACMESTATIC001", "poolType":"Static IP", "isDefaultPool":true }, { "poolName":"ACMEDYNAMIC001", "poolType":"Dynamic IP", "isDefaultPool":false } ], "servicePlans":[ { "name":"", "code":"92876", "sizeKb":, "carrierServicePlanCode":"", "extendedAttributes":"" }, { "name":"", "code":"92876", "sizeKb":, "carrierServicePlanCode":"", "extendedAttributes":"" } ] } ``` ### Failure Responses Status 400 All error messages are returned in this format: ```json { "errorCode": "error code string", "errorMessage": "error message string" } ```