The SMS Works API
credits
Copy Page
The SMS Works API
auth
/auth/getApiKey
GET
/auth/token
POST
batch messages
/batch/schedule
POST
/batch/send
POST
/batch/{batchid}
GET
/batches/schedule/{batchid}
DELETE
credits
/credits/balance
GET
messages
/message/flash
POST
/message/schedule
POST
/message/send
POST
/messages
POST
/messages/failed
POST
/messages/inbox
POST
/messages/schedule/{messageid}
DELETE
/messages/{messageid}
DELETE
/messages/{messageid}
GET
utils
/utils/errors/{errorcode}
GET
/utils/test
GET
credits
MCP
Copy Page
/credits/balance
GET
/credits/balance
Try it
Run in Apidog
Run in Apidog
Returns the number of credits currently available on the account
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
--request
GET
'https://api.thesmsworks.co.uk/v1/credits/balance'
Response
Response Example
200 -
Example 1
{
"credits"
:
180
}
Request
None
Responses
🟢
200
Success
application/json
Generate Code
Body
Generate Code
🔴
500
Error
Modified atÂ
2022-09-11 19:34:57
Previous
/batches/schedule/{batchid}
Next
/message/flash