# API Reference for 5G Business Internet (5G BI) ## Quick Reference for the 5G BI API Endpoints | Task | HTTP Request | | -------------------- | ------------------------------------- | |Device Attributes| [POST /m2m/v1/devices/actions/list](https://thingspace.verizon.com/documentation/api-documentation.html#/http/5g-business-internet/api-endpoints/business-internetlist-device-information) | |Activating a 5G Business Internet Device| [POST /m2m/v1/devices/actions/activate](https://thingspace.verizon.com/documentation/api-documentation.html#/http/5g-business-internet/api-endpoints/business-internetactivate-using-post) | |Change a 5G Business Internet Service Plan| [PUT /m2m/v1/devices/actions/plan](https://thingspace.verizon.com/documentation/api-documentation.html#/http/5g-business-internet/api-endpoints/business-internet-serviceplanchange) | ## Supporting API Endpoints The 5G BI service builds on the existing Connectivity Management API endpoints. Useful endpoints are listed here and in the sections below: - [Device Location](https://thingspace.verizon.com/documentation/api-documentation.html#/http/device-location/overview) - [Fixed Wireless Access (FWA) Address Qualification](https://thingspace.verizon.com/documentation/api-documentation.html#/http/thingspace-intelligence/api-endpoints/fixed-wireless-qualification/domestic-4-g-and-5g-fixed-wireless-qualification) ## Session Management |Task|HTTP Request| |-----|-----| |Start a Connectivity Management session|[POST /m2m/v1/session/login](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/api-endpoints/start-connectivity-management-session)| |End a Connectivity Management session|[POST /m2m/v1/session/logout](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/api-endpoints/end-connectivity-management-session)| |Get a new Connectivity Management API password|[PUT /m2m/v1/session/password/actions/reset](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/api-endpoints/reset-connectivity-management-password)| ## Device Service Provisioning and Management | Task | HTTP Request | | ------------------------------------------------ | ------------------------------------------------------ | |Domestic 4G and 5G Fixed Wireless qualification|[POST /m2m/v1/intelligence/wireless-coverage](https://thingspace.verizon.com/documentation/api-documentation.html#/http/thingspace-intelligence/wireless-network-performance/api-reference/domestic-4g-and-5g-fixed-wireless-qualification)| |Go to state for a device|[PUT /m2m/v1/devices/actions/goToState](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/update-devices-state)| |Change device contact information| [PUT /m2m/v1/devices/actions/contactInfo](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/update-devices-contact-info/update-devices-contact-information) | |Change device cost center| [PUT /m2m/v1/devices/costCenter](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/update-device-cost-center-code/update-devices-cost-center-code) | |Suspend service for devices| [POST /m2m/v1/devices/actions/suspend](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/suspend-service-for-devices/suspend-service-for-devices) | |Restore service for suspended devices| [POST /m2m/v1/devices/actions/restore](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/restore-service-for-suspended-devices/restore-service-for-suspended-devices) | |Deactivate service for devices| [POST /m2m/v1/devices/actions/deactivate](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/deactivate-service-for-devices/deactivate-service-for-devices) | |Check the status of an activation order and where the order is in the provisioning process|[GET /m2m/v1/devices/requests/status](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/uses-and-requirements/check-the-status-of-an-activation-order)| |Check whether devices are available to be activated|[POST /m2m/v1/devices/availability/actions/list](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/check-devices-availability-for-activation)| |Add devices without activating service|[POST /m2m/v1/devices/actions/add](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/add-devices)| |Delete deactivated devices|[POST /m2m/v1/devices/actions/delete](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/delete-deactivated-devices)| |Get detailed information about devices|[POST /m2m/v1/devices/actions/list](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/list-devices-information)| |Get service suspension status for devices|[POST /m2m/v1/devices/suspension/status](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/get-device-service-suspension-status)| |Change device identifiers to match hardware changes|[PUT /m2m/v1/devices/{serviceType}/actions/deviceId](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/update-device-id)| |Change custom field values for devices|[PUT /m2m/v1/devices/actions/customFields](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/update-devices-custom-fields)| |Changes or removes the `CostCenterCode` value for devices|[PUT /m2m/v1/devices/costCenter](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/update-devices-cost-center-code)| |Get the current processing status of an asynchronous request|[GET /m2m/v2/accounts/{accountName}/requests/{requestID}/status](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/account-requests/get-current-asynchronous-request-status)| ## Connectivity and Service History | Task | HTTP Request | | --------------------------------- | -------------------------------------- | |Retrieve device usage history| [POST /m2m/v1/devices/usage/actions/list](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/list-devices-usage-history/list-devices-usage-history) | |Retrieve aggregate device usage history| [POST /m2m/v1/devices/usage/actions/list/aggregate](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/retrieve-aggregate-device-usage-history/retrieve-aggregate-device-usage-history) | |Retrieve device provisioning history| [POST /m2m/v1/devices/history/actions/list](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/list-devices-provisioning-history/list-devices-provisioning-history) | |Retrieve device connection history| [POST /m2m/v1/devices/connections/actions/listHistory](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-management/retrieve-device-connection-history/retrieve-device-connection-history) | ## Device Groups |Task|HTTP Request| |-----|-----| |Create a Device Group|[POST /m2m/v1/groups](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-groups/create-device-group)| |Update a Device Group|[PUT /m2m/v1/groups/{accountName}/name/{groupName}](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-groups/update-device-group)| |Get a List of Device Groups for an Account|[GET /m2m/v1/groups/{accountName}](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-groups/list-device-groups)| |Get Information about a Device Group|[GET /m2m/v1/groups/{accountName}/name/{groupName}](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-groups/get-device-group-information)| |Delete a Device Group|[DELETE /m2m/v1/groups/{accountName}/name/{groupName}](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/device-groups/delete-device-group)| ## Service Plans |Task|HTTP Request| |-----|-----| |Get a list of service plans in an account|[GET /m2m/v1/plans/{accountName}](https://thingspace.verizon.com/documentation/api-documentation.html#/http/global-iot-orchestration/uses-and-requirements/retrieve-the-list-of-service-plans)| ## Callbacks For more information about callbacks, please visit [About Callback Services](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/working-with-verizon-wireless/about-callback-services) and [Callback Best Practices](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/working-with-verizon-wireless/callback-best-practices). |Task|HTTP Request| |-----|-----| |Create a new trigger that sends an alert callback based on specified device usage|[POST /m2m/v1/trigger](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/uses-and-requirements/create-a-trigger-for-usage-notifications)| |Register a callback listener URL|[POST /m2m/v1/callbacks](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/connectivity-callbacks/register-callback)| |Get a list of registered callback listener URLs|[GET /m2m/v1/callbacks](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/connectivity-callbacks/list-registered-callbacks)| |Delete a callback listener URL|[DELETE /m2m/v1/callbacks](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/connectivity-callbacks/deregister-callback)| ## Accounts and Leads |Task|HTTP Request| |-----|-----| |Get information about an account|[GET /m2m/v1/accounts/{accountName}](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/accounts/get-account-information)| |Get a list of leads in an account|[GET /m2m/v1/leads/{accountName}](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/accounts/list-account-leads)| |Retrieve a list of registered device SKUs|[POST /m2m/v1/accounts/{accountName}/sku](https://thingspace.verizon.com/documentation/apis/connectivity-management/api-reference/retrieve-device-sku-list.html)| ## Device Reachability Monitoring - Diagnostics More information at [Device Reachability](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/api-endpoints/device-monitoring/api-reference). |Task|HTTP Request| |-----|-----| |Monitor device reachability|[POST /m2m/v1/diagnostics/basic/devicereachability](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/api-endpoints/device-monitoring/device-reachability/device-reachability)| |Stop device reachability monitoring|[DELETE /m2m/v1/diagnostics/basic/devicereachability](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/api-endpoints/device-monitoring/stop-device-reachability/api-reference)| |Retrieve active reachability monitoring|[POST /m2m/v1/diagnostics/basic/devicereachability/monitors](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/api-endpoints/device-diagnostics/retrieve-active-monitors-using-post/api-reference)| |Retrieve reachability status|[POST /m2m/v1/diagnostics/basic/devicereachability/status](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/api-endpoints/device-diagnostics/device-reachability-status-using-post/api-reference)|