WINSMS
  1. subaccounts
WINSMS
  • credits
    • Get your current WinSMS credit balance
      GET
    • Transfer credits between main and sub accounts.
      POST
  • shortcode
    • Get a list of incoming short/long code messages
      GET
  • sms
    • Get a list of incoming SMS messages
      GET
    • Get a list of incoming opt-out SMS messages
      GET
    • Send SMS messages
      POST
    • Send multiple different SMS messages
      POST
    • Get SMS delivery statuses
      POST
    • Get a list of scheduled SMS messages
      GET
    • Delete scheduled SMS messages and refund credits
      POST
  • subaccounts
    • Get a list of all Sub Accounts.
      GET
  1. subaccounts

Get a list of all Sub Accounts.

GET
/subaccounts
subaccounts
Get a list of all the Sub Accounts owned by the Main Account.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://www.winsms.co.za/api/rest/v1/subaccounts'
Response Response Example
200 - Example 1
{
  "statusCode": 200,
  "subAccounts": [
    {
      "accountNumber": 58324,
      "creditBalance": 201.4,
      "firstName": "Jon",
      "loginName": "jon@castleblack.com",
      "surname": "Snow"
    },
    {
      "accountNumber": 98676,
      "creditBalance": 1936,
      "firstName": "Daenerys",
      "loginName": "khaleesi",
      "surname": "Targaryen"
    }
  ],
  "timeStamp": "20170117054658978",
  "version": "1.0"
}

Request

None

Responses

🟢200OK
application/json
Body
statusCode
integer 
optional
The http status code returned - reflected in the body for convenience
subAccounts
array[object (subAccount) {5}] 
optional
An array of subAccount objects containing properties of each Sub Account owned by the Main Account.
accountNumber
integer 
optional
The WinSMS account number of the Sub Account. This is supplied as an integer, without the leading 'W' displayed in the WinSMS Client Zone.
Example:
58324
creditBalance
number 
optional
The remaining credit balance for the Sub Account.
Example:
201.4
firstName
string 
optional
The first name of the user that the Sub Account is registered to.
Example:
Jon
loginName
string 
optional
The login name of the user that the Sub Account is registered to.
Example:
jon@castleblack.com
surname
string 
optional
The surname of the user that the Sub Account is registered to.
Example:
Snow
timeStamp
string 
optional
The date/time the request was processed, in the format YYYYMMDDhhmmssSSS
version
string 
optional
The current version of the API of the endpoint that was called
🟠401Unauthorized
🟠404Not found
🟠405Method Not Allowed
🔴500Internal Server Error
Modified at 2023-08-15 09:05:19
Previous
Delete scheduled SMS messages and refund credits
Built with