Welcome to the Abzorb API documentation, developed to support seamless third-party integration with Abzorb Technology’s CRM/ERP platform. This API offers a broad suite of capabilities, including customer management, connection oversight, mobile order processing, ticket handling, and real-time data usage monitoring for active connections. It provides a robust and flexible interface, enabling developers to integrate their systems efficiently with the services offered by Abzorb Technology.
\nThe Abzorb API is built on RESTful principles, utilising predictable, resource-oriented URLs. It delivers JSON-formatted responses and adheres to standard HTTP status codes and authentication mechanisms, ensuring consistency and ease of use for developers.
\nPlease see a list of deployments alongside the base API URL for each deployment below.
\nThe Abzorb Technology API now uses OAuth 2.0 (Client Credentials flow) for authentication. Each registered API user is issued a unique client_id and client_secret.
To interact with the Abzorb Technology API, you must first obtain an OAuth 2.0 access token using the Client Credentials Grant.
\nPOST https://{environment}/token\n\nThe request must use HTTP Basic Authentication with your client credentials:
\nUsername: YOUR_CLIENT_ID
Password: YOUR_CLIENT_SECRET
In addition, the body of the request must include grant_type=client_credentials as application/x-www-form-urlencoded:
POST /token HTTP/1.1\nHost: stagingapi.click2sign.co.uk\nAuthorization: Basic BASE64_ENCODED_CLIENT_ID_AND_SECRET\nContent-Type: application/x-www-form-urlencoded\ngrant_type=client_credentials\n\nNote: Encode your client ID and secret as Base64 (client_id:client_secret) for the Authorization: Basic header.
Successful Response:
\n{\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR...\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600\n}\n\naccess_token – a JWT that must be included in all subsequent API requests.
token_type – always bearer.
expires_in – lifetime of the token in seconds (e.g., 3600 = 1 hour).
When the token expires, request a new one using the same client credentials.
\nInclude the token in the Authorization header when making API requests:
GET /api/Connections/ HTTP/1.1\nHost: stagingapi.click2sign.co.uk\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR...\n\nAll requests must be authenticated with a valid OAuth 2.0 access token.
\nOnly HTTPS-secured communications are supported. Any attempt to access API resources over HTTP will result in an HTTP 301 redirect.
\nResponses are returned in JSON format.
\nThe Abzorb Technology API uses standard HTTP response codes to indicate the result of API requests. These codes typically follow the conventions below:
\n2xx codes indicate successful operations.
\n4xx codes denote client-side errors, such as missing parameters or malformed requests.
\n5xx codes reflect server-side errors, representing issues within Abzorb Technology's infrastructure—these occurrences are rare.
\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 the OAuth 2.0 flow fails, the API will return an error response in JSON format.
\nInvalid or missing client credentials (at token request):
\n{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client_id or client_secret is invalid.\"\n}\n\nInvalid or expired access token (at API request):
\n{\n \"error\": \"invalid_token\",\n \"error_description\": \"The access token is invalid or has expired.\"\n}\n\nInsufficient scope (token does not grant access to the requested resource):
\n{\n \"error\": \"insufficient_scope\",\n \"error_description\": \"The access token does not grant the required permissions.\"\n}\n\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 Account Manager 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":"60bcc004-ce2f-4b03-aef7-6e655a47419d","publishedId":"2sB3QMMpdt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-14T11:01:23.000Z"},"item":[{"name":"Alerting Controller","item":[{"name":"Appendix","item":[],"id":"0f031be7-be26-4214-9ebd-721ec692cf0d","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\n`GET /api/alerting/UpdatePartialCLIAlert/`
This endpoint is used to update any indiviual CLI Alerting setting for a specifc CLI at a Customer level.
\n`PATCH`
None
The request body should contain a JSON object representing the model used to update the CLI alerting settings.
\n{\n \"CustomerID\": 0,\n \"ContractID\": 0,\n \"CLI\": \"\",\n \"CLI_ID\": 0,\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\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 retrieves active bars for Vodafone.
\n`GET`
None
[\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`
None
Content-Type: application/json
{\n \"cli\":\"\",\n \"barSuffix\":\"\",\n \"toggle\":true,\n \"comment\":\"\"\n}\n\n{\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 for Vodafone.
\n`GET`
None
[\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 a list of bundles active against a specific tariff.
\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`
None
Content-Type: application/json
{\n \"tariffOptionId\":0,\n \"contractId\":0\n}\n\n{\n \"success\": true,\n \"diary_entry_id\": 123456,\n \"response_message\": \"\"\n}\n\n`POST /api/Bundles/RemoveBundles/`
This endpoint allows an API user to remove a bundle against a connection associated to their account.
\n`POST`
None
Content-Type: application/json
{\n \"tariffOptionId\":0,\n \"contractId\":0\n}\n\n{\n \"success\": true,\n \"diary_entry_id\": 123456,\n \"response_message\": \"\"\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.
\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`
None
Content-Type: application/json
{\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\": true,\n \"CoRegNumber\": \"\"\n}\n\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`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`
None
Content-Type: application/json
{\n \"cli\": \"\",\n \"contractId\": 0,\n \"divertCli\": \"\",\n \"toggleStatus\": true\n}\n\n{\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":"761bc2f1-98ef-4fd4-823e-a592800f0657","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"POST /api/exports/exportconnections
This endpoint queues an asynchronous job to generate a CSV export of all connections accessible to the authenticated API user that fall within the supplied date range. The export is processed in the background and must be polled for completion.
\nPOST
None
\n{\n \"format\": \"csv\",\n \"fromDate\": \"2026-01-01T00:00:00Z\",\n \"toDate\": \"2026-01-31T23:59:59Z\"\n}\n\n{\n \"exportId\": \"8f3c2c9e-6a9d-4a7b-9b8c-3b6c9f0a2f14\",\n \"status\": \"Queued\"\n}\n\nGET /api/exports/GetExportStatus?exportId={exportId}
This endpoint returns the current status of a previously requested connections CSV export. It is intended to be polled until the export reaches a Completed or Failed state.
GET
{\n \"exportId\": \"8f3c2c9e-6a9d-4a7b-9b8c-3b6c9f0a2f14\",\n \"status\": \"Processing\"\n}\n\n{\n \"exportId\": \"8f3c2c9e-6a9d-4a7b-9b8c-3b6c9f0a2f14\",\n \"status\": \"Completed\",\n \"rowCount\": 128734,\n \"fromDate\": \"2026-01-01T00:00:00Z\",\n \"toDate\": \"2026-01-31T23:59:59Z\",\n \"expiresAt\": \"2026-02-07T23:59:59Z\",\n \"downloadUrl\": \"https://api.example.com/api/exports/connections/8f3c2c9e-6a9d-4a7b-9b8c-3b6c9f0a2f14/download\"\n}\n\nGET /api/exports/downloadConnectionsExportCsv?exportId={exportId}
This endpoint downloads the generated CSV file for a completed connections export. The export must be in a Completed state and not expired.
GET
CLI,Network,Status,CustomerName,Tariff,StartDate,LastModifiedDate\n07123456789,O2,Active,Acme Ltd,Business 10GB,2026-01-02,2026-01-15\n07123456790,EE,Active,Acme Ltd,Business 5GB,2026-01-03,2026-01-18\n07123456791,Vodafone,Paused,Globex Corp,Unlimited Data,2026-01-05,2026-01-20\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
[\n {\n \"ConnectionTypeID\":1,\n \"Description\":\"New\"\n },\n {\n \"ConnectionTypeID \":2,\n \"Description\":\"Port\"\n },\n {\n \"ConnectionTypeID\":3,\n \"Description\":\"Migrate\"\n },\n {\n \"ConnectionTypeID \":4,\n \"Description\":\"Upgrade\"\n }\n]\n\n`GET/api/Order/GetBillCapEligibleTariffs/`
This API endpoint retrieves Bill Cap eligible tariffs
\n`GET`
None