Atomic API

NBN Services

List active NBN services and search available coverage areas

GET/api/atomic/customer/nbn/service

NBN Services

List NBN services

Parameters

customer_idstringqueryrequired

Customer ID

service_idstringqueryoptional

Prefixed with NBNxxxxxxxxx

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/nbn/service?customer_id={customer_id}&service_id={service_id}" \
  -H "Authorization: {{your_access_token}}"
Response
200 Success
[
  {
    "customer_name": "John Doe",
    "customer_id": 8888,
    "service_name": "John's Super Internet",
    "service_id": "NBN9800000038",
    "service_plan": "NBN 100 (Fixed IP)",
    "service_address": "123 Some Street, Sydney, NSW, 2000",
    "technology_type": "FTTP",
    "location_id": "LOC123456789",
    "activate_date": "2024-10-29 05:30:28",
    "nbn_service_cancel_date": null,
    "ip_address": "8.8.8.8"
  }
]
POST/api/atomic/customer/nbn/address_search

NBN Address Search

Search for NBN service addresses

Parameters

addressstringrequired

Address to search

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/nbn/address_search" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "1 Eagle St Brisbane"
}'
Response200 Success
[
  {
    "responseData": [
      {
        "id": "LOC123456",
        "formattedAddress": "1 EAGLE ST, BRISBANE QLD 4000",
        "roadNumber1": "1",
        "roadName": "EAGLE",
        "roadTypeCode": "ST",
        "postcode": "4000",
        "localityName": "BRISBANE",
        "stateTerritoryCode": "QLD",
        "latitude": "-27.467",
        "longitude": "153.028"
      }
    ]
  }
]
Back to API Documentation