Welcome to the Abzorb API documentation, designed for third-party integration with Abzorb’s CRM/ERP platform. Our API provides extensive capabilities to manage customers, oversee connections, facilitate mobile orders, handle ticket management, monitor data usage for active connections, and much more. It serves as a dynamic interface enabling developers to seamlessly integrate their systems with Abzorb's services.
\nThe Abzorb API is architected around REST principles. Our API employs predictable resource-oriented URLs, returns JSON-encoded responses, and adheres to standard HTTP response codes and authentication methods.
\nPlease see a list of deployments alongside the base API URL for each deployment below.
\nThe Abzorb API utilises username/password authentication, where credentials are encoded as a Base64 string. Each API call requires an HTTP header with the key Authorization. The corresponding value should be Basic followed by your encoded username and password.
To start using the Abzorb API, please pay close attention to the following:
\nYou must use valid credentials to send requests to the API endpoints.
\nThe API only responds to HTTPS-secured communications. Any requests sent via HTTP will return an HTTP 301 redirect to the corresponding HTTPS resources.
\nThe API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
The Abzorb API utilises standard HTTP response codes to convey the outcome of API requests. Typically:
\nCodes in the 2xx range signify successful operations.
\nCodes in the 4xx range indicate client errors, such as missing required parameters or invalid requests.
\nCodes in the 5xx range signify server errors, reflecting issues on Abzorb's end, which are infrequent.
\nWithin an API call, if the request is successfully but fails validation, a validation message will return as per the below example:
\n{ \n \"response_message\": \"error_message\"\n}\n\nIf invalid API credentials are provided, you will receive an HTTP 401 Unauthorized response code.
\nCertain methods require a contractIdinstead of a cli. A contractIdserves as a unique identifier for a cli. To obtain a CLI’s contractId, view the cliat /api/Connections/?cli=XX, etc. A ContractID may also be referred to as a ConnectionID—they are synonymous. In addition, companyId may also be referred to as customerId.
Some method types necessitate parameters that cannot be supplied directly. These parameters, such as DiaryTypeID, DiaryTaskID, BarSuffix, and StatusID, are provided within seperate API calls within their appropriate controllers.
\nAdditional information you may need to input can be accessed by querying CLIs using existing information. For instance, a customerId is associated with a CLI upon viewing it. This customerId is the unique identifier of the customer who owns that connection within our system. It is typically required for creating tasks to ensure they are correctly associated with the customer’s account and portal.
An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, please contact Portal Support.
In case you have questions or require assistance, please contact your Business Development Manager (BDM) who will be able to forward your query to the API development team.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"49139871","collectionId":"75b61dbd-d1c3-45d0-80d1-f692f4a20c7d","publishedId":"2sB3QRondn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-23T13:12:58.000Z"},"item":[{"name":"Alerting Controller","item":[{"name":"Appendix","item":[],"id":"a7d4e21a-98d5-44f0-8aa8-46723b6a3127","description":"This subfolder hosts supplementary API calls that support or extend the functionality of the main /alerting endpoints.
`GET /api/alerting/GetAllResellerDefaults/`
This endpoints returns all Alerting defaults associated to the Reseller of the connected API user
\n`GET`
None
[\n {\n \"CustomerID\": 0,\n \"Customer\": \"\",\n \"ResellerID\": 0,\n \"DistributorID\": 0,\n \"Level\": \"\",\n \"Default_Threshold\": 0.0,\n \"Default_Data_Usage\": 0.0,\n \"Data_Step\": 0.0,\n \"Default_Minutes_Usage\": 0.0,\n \"Minutes_Step\": \"0.0,\n \"Default_SMS_Usage\": 0.0,\n \"SMS_Step\": 0.0,\n \"Default_Email\": \"\",\n \"AllowSMSAlerts\": false\n }\n]\n\n`GET /api/alerting/GetCustomerAlertSettings/`
This endpoints returns all Alerting defaults associated against a specific customer
\n`GET`
[\n {\n \"CustomerID\": 0,\n \"Customer\": \"\",\n \"ResellerID\": 0,\n \"DistributorID\": 0,\n \"Level\": \"\",\n \"Default_Threshold\": 0.0,\n \"Default_Data_Usage\": 0.0,\n \"Data_Step\": 0.0,\n \"Default_Minutes_Usage\": 0.0,\n \"Minutes_Step\": \"0.0,\n \"Default_SMS_Usage\": 0.0,\n \"SMS_Step\": 0.0,\n \"Default_Email\": \"\",\n \"AllowSMSAlerts\": false\n }\n]\n\n`GET /api/alerting/GetCliAlertingBarStatus/`
This endpoints returns the CLI alerting bar status for a given ContractId.
\n`GET`
{\n \"Cli\": \"\",\n \"AutoBar\": false,\n \"BillCapEnabled\": false,\n \"BarStatus\": false\n}\n\n`GET /api/alerting/GetCustomerCliAlertSettings/`
This endpoints returns all the CLI alerting defaults for the connections associated to a specific customer based on a provided alertinglevel
`GET`
[\n {\n \"CustomerID\": 0,\n \"Customer\": \"\",\n \"ResellerID\": 0,\n \"DistributorID\": 0,\n \"Level\": \"\",\n \"Default_Threshold\": 0.0,\n \"Default_Data_Usage\": 0.0,\n \"Data_Step\": 0.0,\n \"Default_Minutes_Usage\": 0.0,\n \"Minutes_Step\": \"0.0,\n \"Default_SMS_Usage\": 0.0,\n \"SMS_Step\": 0.0,\n \"Default_Email\": \"\",\n \"AllowSMSAlerts\": false\n }\n]\n\n`GET /api/alerting/UpdateCLIAlertSettings/`
This endpoints is used to update the store CLI Alerting settings for a specifc CLI based on a provided level
`POST`
None
The request body should contain a JSON object representing the model used to update the CLI alerting settings.
\n{\n \"Level\": \"\",\n \"CustomerID\": 0,\n \"CLI_ID\": 0,\n \"CLI\": \"\",\n \"Alert_Email\": \"\",\n \"Cost_Threshold\": 0.0,\n \"Data_Threshold\": 0.0,\n \"Data_Step\": 0.0,\n \"Minutes_Threshold\": 0.0,\n \"Minutes_Step\": 0.0,\n \"SMS_Threshold\": 0.0,\n \"SMS_Step\": 0.0,\n \"Cost_Autobar\": false,\n \"Usage_Autobar\": false,\n \"SMS\": false,\n \"AllowSMSAlerts\": false,\n \"BillCap\": false,\n \"Current_Cost\": 0.0,\n \"Current_Data\": 0.0,\n \"Current_Minutes\": 0.0,\n \"Current_SMS\": 0.0\n}\n\n{\n \"success\": true,\n \"response_message\": \"\"\n}\n\n`POST /api/alerting/UpdateCompanyDefaults/`
This endpoint is used to update the Alerting defaults for a company
\n`POST`
None
The request body should contain a JSON object representing the model used to update the Alerting company defaults.
\n{\n \"CustomerID\": 0,\n \"Customer\": \"\",\n \"ResellerID\": 0,\n \"DistributorID\": 0,\n \"Level\": \"\",\n \"Default_Threshold\": 0.0,\n \"Default_Data_Usage\": 0.0,\n \"Data_Step\": 0.0,\n \"Default_Minutes_Usage\": 0.0,\n \"Minutes_Step\": 0.0,\n \"Default_SMS_Usage\": 0.0,\n \"SMS_Step\": 0.0,\n \"Default_Email\": \"\",\n \"AllowSMSAlerts\": true\n}\n\n{\n \"success\": true,\n \"response_message\": \"\"\n}\n\nThis subfolder contains the primary API calls for the /api/alertingendpoint.
The /alerting endpoint allows you to view and update core alerting settings for a connection
`GET /api/Bars/GetAvailableBars/`
This API endpoint makes an HTTP GET request to retrieve active bars for a specific network or for all networks.
\nIf the networkCode is kept null, available bars will return for all networks.
Applicable networkCode values are listed below:
`GEt`
[\n {\n \"TariffLevelOptionID\": 0,\n \"Description\": \"string\",\n \"NetworkSuffix\": \"string\",\n \"Network\": \"string\",\n \"BarCategory\": \"string\",\n \"DefaultOn\": true, // Indicates if the bar is on by default at network level\n }\n]\n\nThis subfolder hosts supplementary API calls that support or extend the functionality of the main /barsendpoints.
`POST /api/bars/ToggleBar/`
This endpoint is used to toggle a bar on/off for a given connection.
\n`POST`
{\n \"success\": true,\n \"diary_entry_id\": 123456,\n \"response_message\": \"\"\n}\n\n`GET /api/Bars/GetAssignedBars/`
Retrieves bars that are currently active against the provided contract IDs.
\n`GET`
[\n {\n \"ConnectionId\": 0,\n \"NetworkSuffix\": \"string\",\n \"Description\": \"string\",\n \"TariffLevelOptionID\": 0\n }\n]\n\n`GET /api/Bars/GetBars/`
This endpoint retrieves information about bars available to apply under one or more ContractIDs.
\n`GET`
[\n {\n \"TariffLevelOptionID\": 0,\n \"NetworkID\": 0,\n \"Description\": \"string\",\n \"NetworkSuffix\": \"string\",\n \"ISAAC_Add\": \"string\",\n \"ISAAC_Remove\": \"string\",\n \"PortalName\": \"string\",\n \"Notes\": \"string\",\n \"TLO_Bit\": 0,\n \"DefaultOn\": true, // Indicates if the bar is on by default at network level\n \"Toggle\": \"string\",\n \"Command\": \"string\",\n \"Active\": true // Indicates if the bar is active i.e. available to apply\n }\n]\n\nThis subfolder contains the primary API calls for the /api/barsendpoint.
The /bars endpoint allows you add, remove and view bars against mobile connections.
`GET /api/Bundles/ListBundlesForNetwork/`
This endpoint retrieves bundles available against a specific network.
\nApplicable networkCode values are listed below:
`GET`
StartFragment
\n[\n {\n \"TariffOptionID\": 0,\n \"Description\": \"\",\n \"ServiceRetailPrice\": 0.00\n },\n {\n \"TariffOptionID\": 0,\n \"Description\": \"\",\n \"ServiceRetailPrice\": 0.00\n }\n]\n\n`GET /api/Bundles/ListBundlesForTariff/`
Retrieves bars that are currently active against the provided contract IDs.
\nStartFragment
\n[\n {\n \"TariffOptionID\":0,\n \"Description\":\"\",\n \"ServiceRetailPrice\":0\n }\n]\n\nThis subfolder hosts supplementary API calls that support or extend the functionality of the main /bundles endpoints.
`POST /api/Bundles/AddBundle/`
This endpoint allows an API user to add a bundle against a connection associated to their account
\n`POST`
{\n \"success\": true,\n \"diary_entry_id\": 123456,\n \"response_message\": \"\"\n}\n\n`POST /api/Bundles/RemoveBundles/`
Allows for a bundle to be removed from a connection.
\n`POST`
{\n \"success\": true,\n \"diary_entry_id\": 123456,\n \"response_message\": \"\"\n}\n\n`POST /api/Bars/GetAssignedBundles/`
Retrieves bundles that are currently active against the provided contract IDs. The contracts must be supplied as a list of contract IDs in the request body.
\n`POST`
[\n 12345,\n 67890,\n 24680\n]\n\nNone
[\n {\n \"ContractId\": 123456,\n \"TariffOptionID\": 1234,\n \"Description\":\"O2 World Daily Data Roaming\",\n \"BundleStartDate\":\"2024-06-12T00:00:00\"\n }\n]\n\nThe /bundles endpoint allows for bundles to be viewed, added and removed against mobile connections.
This subfolder hosts supplementary API calls that support or extend the functionality of the main /cliendpoints.
`GET /api/Connections/GetConnectionByCustomerID/`
Retrieves a list of connections associated to a specific customer
\n`GET`
[\n {\n \"Network\":\"\",\n \"Bars\":[\n ],\n \"Bundles\":[\n ],\n \"Term\":0,\n \"ConnectionId\":0,\n \"NetworkID\":0,\n \"CustomerName\":\"\",\n \"ResellerID\":0,\n \"DistributorID\":0,\n \"CustomerID\":0,\n \"TLO_Bit\":0,\n \"PUKCode\":\"\",\n \"username\":\"\",\n \"TariffID\":0,\n \"CLI\":\"\",\n \"SimNo\":\"\",\n \"Tariff\":\"\",\n \"CustomerAdminID\":0,\n \"StartDate\":\"\",\n \"TerminationDate\":\"\",\n \"Status\":\"\"\n }\n]\n\nStartFragment
\n`GET api//Connections/`
Retrieves a list of all active connections associated to the API user.
\n`GET`
None
\n[\n {\n \"Network\":\"\",\n \"Bars\":[\n ],\n \"Bundles\":[\n ],\n \"Term\":0,\n \"ConnectionId\":0,\n \"NetworkID\":0,\n \"CustomerName\":\"\",\n \"ResellerID\":0,\n \"DistributorID\":0,\n \"CustomerID\":0,\n \"TLO_Bit\":0,\n \"PUKCode\":\"\",\n \"username\":\"\",\n \"TariffID\":0,\n \"CLI\":\"\",\n \"SimNo\":\"\",\n \"Tariff\":\"\",\n \"CustomerAdminID\":0,\n \"StartDate\":\"\",\n \"TerminationDate\":\"\",\n \"Status\":\"\"\n }\n]\n\n`GET /api/Connections/GetConnectionByCLI/`
Retrieves connection details for a specific CLI including key CapZ settings
\n`GET`
[\n {\n \"Network\": \"\",\n \"Bars\": [],\n \"Bundles\": [],\n \"Term\": 0,\n \"ConnectionId\": 0,\n \"NetworkID\": 0,\n \"CustomerName\": \"\",\n \"ResellerID\": 0,\n \"DistributorID\": 0,\n \"CustomerID\": 0,\n \"TLO_Bit\": 0,\n \"PUKCode\": \"\",\n \"username\": \"\",\n \"TariffID\": 0,\n \"Alert_Email\": \"\",\n \"SMSEnabled\": false, \n \"Cost_Threshold\": 0.0,\n \"Data_Threshold\": 0.0,\n \"Minutes_Threshold\": 0.0,\n \"SMS_Threshold\": 0.0,\n \"Data_Step\": 0.0,\n \"Minutes_Step\": 0.0,\n \"SMS_Step\": 0.0,\n \"Cost_AutoBar\": false,\n \"Usage_AutoBar\": false,\n \"IsBillCapEnabled\": false,\n \"IsBillCapEligible\": false,\n \"Current_Cost\": 0.00,\n \"Current_Data\": 0.00,\n \"Current_Minutes\": 0.00,\n \"Current_SMS\": 0.00,\n \"CLI\": \"\",\n \"SimNo\": \"\",\n \"Tariff\": \"\",\n \"CustomerAdminID\": 0,\n \"StartDate\": \"\",\n \"TerminationDate\": \"\",\n \"Status\": \"\"\n }\n]\n\nThis subfolder contains the primary API calls for the /api/cliendpoint.
The /connections endpoint is used to manage all connections associated to the API user.
`GET /api/Customer/GetCustomerBusniessTypes/`
This endpoint is used to retrieve a list of applicable customer business types which can be used when creating a customer.
\n`GET`
None
[\n {\n \"BusinessTypeID\": 0,\n \"Description\": \"\"\n },\n {\n \"BusinessTypeID\": 0,\n \"Description\": \"\"\n },\n {\n \"BusinessTypeID\": 0,\n \"Description\": \"\"\n }\n]\n\nThis subfolder hosts supplementary API calls that support or extend the functionality of the main /customerendpoints.
| Customer ID | \r","Name | \r","Phone | \r","|
|---|---|---|---|
| {{response.CustomerID}} | \r","{{response.Name}} | \r","{{response.Email}} | \r","{{response.Phone}} | \r","
`POST /api/Customer/CreateCustomer/`
This endpoint allows you to create a new customer.
\n`POST`
{\n \"CustomerId\": 0,\n \"CustomerName\": \"\",\n \"Mobile\": \"\",\n \"Email\": \"\",\n \"CustomerType\": 0,\n \"MainTelephone\": \"\",\n \"ResellerMainTelephone\": null,\n \"ResellerMainEmail\": null,\n \"Fax\": \"\",\n \"ResellerID\": 0,\n \"AccountManagerID\": 0,\n \"SalesStaffID\": 0,\n \"DistributorID\": 0,\n \"PrimaryContact\": {\n \"Title\": \"\",\n \"Forename\": \"\",\n \"Surname\": \"\",\n \"Position\": \"\",\n \"Email\": \"\",\n \"Mobile\": \"\",\n \"Telephone\": \"\"\n },\n \"PrimaryContactID\": 0,\n \"PrimaryAddress\": {\n \"PostCode\": \"\",\n \"AddressLine1\": \"\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"AddressTown\": \"\",\n \"AddressCounty\": \"\"\n },\n \"InvoiceAddress\": {\n \"PostCode\": \"\",\n \"AddressLine1\": \"\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"AddressTown\": \"\",\n \"AddressCounty\": \"\"\n },\n \"IsReseller\": null,\n \"CoRegNumber\": \"\",\n \"Connections\": null\n}\n\n`POST /api/Customer/GetCustomers/`
This endpoint is used to retrieve a list of customers associated to the API user.
\n`GET`
None
[\n {\n \"CustomerId\":0,\n \"CustomerName\":\"\",\n \"Mobile\":\"\",\n \"Email\":\"\",\n \"CustomerType\":0,\n \"MainTelephone\":\"\",\n \"ResellerMainTelephone\":null,\n \"ResellerMainEmail\":null,\n \"Fax\":\"\",\n \"ResellerID\":0,\n \"AccountManagerID\":0,\n \"SalesStaffID\":0,\n \"DistributorID\":0,\n \"PrimaryContact\":{\n \"Title\":\"\",\n \"Forename\":\"\",\n \"Surname\":\"\",\n \"Position\":\"\",\n \"Email\":\"\",\n \"Mobile\":\"\",\n \"Telephone\":\"\"\n },\n \"PrimaryContactID\":0,\n \"PrimaryAddress\":{\n \"PostCode\":\"\",\n \"AddressLine1\":\"\",\n \"AddressLine2\":\"\",\n \"AddressLine3\":\"\",\n \"AddressTown\":\"\",\n \"AddressCounty\":\"\"\n },\n \"InvoiceAddress\":{\n \"PostCode\":\"\",\n \"AddressLine1\":\"\",\n \"AddressLine2\":\"\",\n \"AddressLine3\":\"\",\n \"AddressTown\":\"\",\n \"AddressCounty\":\"\"\n },\n \"IsReseller\":null,\n \"CoRegNumber\":\"\",\n \"Connections\":null\n }\n]\n\n`GET /api/Customer/GetCustomerDetails/`
This endpoint is used to retrieve customer details for a specific customer
\n`GET`
{\n \"CustomerId\":0,\n \"CustomerName\":\"\",\n \"Mobile\":\"\",\n \"Email\":\"\",\n \"CustomerType\":0,\n \"MainTelephone\":\"\",\n \"ResellerMainTelephone\":null,\n \"ResellerMainEmail\":null,\n \"Fax\":\"\",\n \"ResellerID\":0,\n \"AccountManagerID\":0,\n \"SalesStaffID\":0,\n \"DistributorID\":0,\n \"PrimaryContact\":{\n \"Title\":\"\",\n \"Forename\":\"\",\n \"Surname\":\"\",\n \"Position\":\"\",\n \"Email\":\"\",\n \"Mobile\":\"\",\n \"Telephone\":\"\"\n },\n \"PrimaryContactID\":0,\n \"PrimaryAddress\":{\n \"PostCode\":\"\",\n \"AddressLine1\":\"\",\n \"AddressLine2\":\"\",\n \"AddressLine3\":\"\",\n \"AddressTown\":\"\",\n \"AddressCounty\":\"\"\n },\n \"InvoiceAddress\":{\n \"PostCode\":\"\",\n \"AddressLine1\":\"\",\n \"AddressLine2\":\"\",\n \"AddressLine3\":\"\",\n \"AddressTown\":\"\",\n \"AddressCounty\":\"\"\n },\n \"IsReseller\":null,\n \"CoRegNumber\":\"\",\n \"Connections\":null\n}\n\nThis subfolder contains the primary API calls for the /api/mainendpoint.
The /customer endpoint allows new customers to be created and existing customer information to be retrieved.
`POST /api/divert/DivertHandset/`
This endpoint is used to toggle a Divert on/off for a given connection.
\n`POST`
{\n \"success\": true,\n \"diary_entry_id\": 123456,\n \"response_message\": \"\"\n}\n\n`GET /api/divert/CheckDivertStatus/`
This endpoint is used to check the divert status for a given connection. Please note, this endpoint will only return the divert status for active Vodafone connections.
\n`GET`
{\n \"IsDivertOn\": true,\n \"ContractId\": 0,\n \"Cli\": \"\",\n \"DivertCli\": \"\",\n \"DiaryEntryId\": 0,\n \"RequestTime\": \"\",\n \"RequestedBy\": \"\"\n}\n\nDivert related API calls
\n","_postman_id":"18b95165-b5a2-482e-ac74-b307740e5729","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"`GET/api/Order/GetBillCapEligibleTariffs/`
This API endpoint retrieves Bill Cap eligible tariffs for a specific network,
\nApplicable networkCode values are listed below:
`GET`
{\n \"TariffID\": 0,\n \"TariffName\": \"\",\n \"RetailCost\": 0.0\n}\n\n`GET/api/Order/GetMobileConnectionTypes/`
This API endpoint retrieves a list of applicable mobile connection types. The 'ConnectionTypeID' value is used within the 'AddMobileToOrder' endpoint.
\n`GET`
None