Documentation
SMS API Account

Accounts and subaccounts

Reference for account overview, account details and subaccount management in the separate API namespace.

The account and subaccount endpoints belong to an older API structure that remains operational. They use /api/... instead of the versioned /v2/... base used by the rest of the SMS API reference.

Build the complete URL against https://api.ip1sms.com.

Account overview

Method Path
GET /api/me
{
  "Account": "ip1-XXXXX",
  "Organization": "The Company",
  "Type": "swedish",
  "Balance": 0.0,
  "Currency": "SEK"
}
Field Description
Account Account ID with the ip1- prefix.
Organization Organization name.
Type Published values are swedish and international.
Balance Balance, which may be positive or negative depending on the payment model.
Currency SEK or EUR.

Account details

Method Path
GET /api/me/account
{
  "Key": "REDACTED",
  "Parent": "ip1-PARENT",
  "Type": "swedish",
  "Balance": 0.0,
  "Currency": "SEK",
  "ID": "ip1-XXXXX",
  "Name": "Department"
}

Key is an authentication secret. Never return it to a browser, write it to logs or expose it in analytics or error reports.

Create a subaccount

Method Path
POST /api/me/children
{
  "Name": "Support"
}

The response uses the account data type below.

List subaccounts

Method Path Description
GET /api/me/children List all subaccounts.
GET /api/me/children/{child} Read a subaccount.

The older page omitted a slash before {child}. The path above follows the pattern used on the update page.

Update a subaccount

Method Path
PUT /api/me/children/{child}
{
  "ID": "ip1-CHILD",
  "Name": "New name"
}

Subaccount data type

{
  "Key": "REDACTED",
  "Parent": "ip1-PARENT",
  "Type": "swedish",
  "Balance": 0.0,
  "Currency": "SEK",
  "ID": "ip1-CHILD",
  "Name": "Support"
}
Field Description
Key Subaccount API key. Treat it as a secret.
Parent Main account ID.
Type Account type.
Balance Subaccount balance.
Currency Subaccount currency.
ID Subaccount ID.
Name Name or business reference.

Create separate keys with the minimum required permissions for each integration. Avoid distributing the main account key to systems that need only a subaccount.

Choose the purposes you consent to. Necessary storage is used only to remember your choice.