REST API Functions
The following table lists all the available REST API functions. For general information about how to use these APIs, see Getting Started.
| API Function | Description |
|---|---|
| Customers | |
| Get Customer Details | Returns information about a given customer. |
| Create a Customer | Creates a customer. |
| Edit Customer Details | Modifies attributes for a given customer. |
| Devices | |
| Search Devices | Searches for devices based on various filters. |
| Get Device Details | Retrieves detailed information for a given device. |
| Edit Device Details | Modifies any device attributes such as SIM status, rate plan, communication plan, custom fields and other identifiers. |
| Get Device Audit History | Returns information about changes made to a given device. |
| Get Device Usage | Retrieves usage-related details for a given device. |
| Get Device Usage by Zone | Returns usage details for a given device, based on a specified zone and billing cycle. |
| Get Session Details | Retrieves information related to the current or most recent session for a given device. |
| Rate Plans | |
| Get Rate Plans | Retrieves information about published rate plans. |
| SMS Messages | |
| Search SMS | Searches for messages that have been sent or received during a specified timeframe. |
| Get SMS Details | Retrieves detailed information about a message. |
| Send SMS | Sends an SMS message to a device. |
| Usages | |
| Get Usage by Rate Plan | Returns usage information for all devices using a given rate plan. |
| General | |
| Echo | Returns the value passed. |