Atomic API

Customers

List, create, and delete sub-customers; view available service plans

GET/api/atomic/customer/list

List Customers

List all sub-customers within your account

Parameters

customer_namestringqueryoptional

Partial names accepted. Leave blank for all.

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/list?customer_name={customer_name}" \
  -H "Authorization: {{your_access_token}}"
Response
200 Success
[
  {
    "customer_id": 5,
    "customer_name": "waqi sc01",
    "account_number": 12345,
    "nickname": "test 01",
    "abn": "123455",
    "addr_1": "test sc01",
    "addr_2": "",
    "postcode": "3000",
    "city": "MELBOURNE",
    "region": "Victoria",
    "country": "Australia",
    "website": "",
    "created_date": "2022-07-25 02:42:02",
    "delete_date": null
  }
]
POST/api/atomic/customer/create

Create Customer

Create a new customer

Parameters

customer_namestringrequired

Customer name

nicknamestringrequired

Customer nickname

addr_1stringrequired

Address line 1

postcodestringrequired

Postcode

countrystringrequired

e.g. Australia

abnstringoptional

Business registration number

addr_2stringoptional

Address line 2

citystringoptional

City

regionstringoptional

Region

websitestringoptional

Website

Request

curl \
  -X POST \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/create" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_name": "ABC",
  "nickname": "ABC",
  "addr_1": "123 Some Street",
  "postcode": "4000",
  "country": "Australia"
}'
Response
200 Success
{
  "customer_id": 5,
  "customer_name": "ABC",
  "account_number": 12345,
  "nickname": "ABC",
  "abn": "",
  "addr_1": "123 Some Street",
  "addr_2": "",
  "postcode": "4000",
  "city": "",
  "region": "",
  "country": "Australia",
  "website": "",
  "created_date": "2025-02-19 11:15:27",
  "delete_date": null
}
GET/api/atomic/service_plan/list

List Plans

List all available service plans

No parameters required.

Request

curl \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/service_plan/list" \
  -H "Authorization: {{your_access_token}}"
Response200 Success
[
  {
    "plan_id": 123,
    "plan_name": "Acme Plan",
    "currency": "AUD",
    "plan_type": "SIP Trunk",
    "price": "1.99"
  },
  {
    "plan_id": 134,
    "plan_name": "Test Plan",
    "currency": "AUD",
    "plan_type": "SMS Plan",
    "price": "1.20"
  }
]
DELETE/api/atomic/customer/delete

Delete Customer

Delete a customer

Parameters

customer_idintegerrequired

Customer ID

Request

curl \
  -X DELETE \
  "https://atvoice-api.atomtelecom.com.au/api/atomic/customer/delete" \
  -H "Authorization: {{your_access_token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": 1
}'
Response
200 Success
{
  "status": "DELETED",
  "customer_id": 1,
  "customer_name": "Test Customer"
}
Back to API Documentation