ClickSend REST API v3
  1. Subaccounts
ClickSend REST API v3
  • Account
    • Get account
      GET
    • Create a new account
      POST
    • Update Account
      PUT
    • Send account activation token
      PUT
    • Verify new account
      PUT
    • Account Usage
      GET
  • Automation Rules
    • List Rules
      GET
    • Create a New Rule
      POST
    • Delete a Rule
      DELETE
    • Get a Specific Rule
      GET
    • Update a Rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List Rules
      GET
    • Create a New Rule
      POST
    • Delete a Rule
      DELETE
    • Get a Specific Rule
      GET
    • Update a Rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
  • Contact Suggestions
    • List Contact Suggestions
  • Countries
    • Get all Countries
  • Delivery Issues
    • Get Delivery Issues
    • Create Delivery Issue
  • Email Marketing
    • Get All Email Campaigns
    • Calculate Price
    • Create Email Campaign
    • Get Specific Email Campaign History
    • Get Specific Email Campaign
    • Update Email Campaign
    • Cancel Email Campaign
    • Send Verification Token
    • Verify Allowed Email Address
    • Get All Allowed Email Addresses
    • Create Allowed Email Address
    • Delete Allowed Email Address
    • Get Specific Allowed Email Address
    • Get All Master Email Templates
    • Get All Master Template Categories
    • Get Specific Email Template Category
    • Get All Templates For Category
    • Get Specific Master Template
    • Get All Email Templates
    • Create New Email Template from Master Template
    • Upload Image to Specific Template
    • Delete Email Template
    • Get Specific Email Template
    • Update an Email Template
  • Transactional Email
    • Email History
    • Export History
    • Email Price
    • Add a Test Delivery Receipt
    • Email Send
  • Fax
    • Export Fax History
    • Get Fax History
    • Calculate Price
    • List of Fax Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Fax Delivery Receipts as read
    • Get a Specific Fax Delivery Receipt
    • Send Fax
  • Forgot Account
    • Forgot Password
    • Verify Forgot Password
    • Forgot Username
  • Contact Lists
    • Get all Contact Lists
    • Create a new contact list
    • Delete a specific contact list
    • Get a specific contact list
    • Update a specific contact list
    • Export Contacts List
    • Import Contacts to List
    • Show CSV Import File Preview
    • Get List of Acceptable Import Fields
    • Remove Duplicate Contacts
  • Contacts
    • Transfer a Contact
    • Get all Contacts in a List
    • Create a new contact
    • Delete a specific contact
    • Get a specific contact
    • Update a specific contact
    • Remove Opted Out Contacts
  • MMS
    • Cancel All MMS
    • Export MMS History
    • Get MMS History
    • Get Price
    • Get all Delivery Receipts
    • Mark Receipts As Read
    • Get Delivery Receipt
    • Send MMS
    • Cancel MMS
  • Numbers
    • Get all Dedicated Numbers
    • Buy dedicated number
    • Search Dedicated Numbers by Country
  • Post Direct Mail
    • List Direct Mail Campaigns
    • Calculate Direct Mail Campaign Price
    • Create New Campaign
    • Search Locations
  • Post Address Detection
    • Detect Address
  • Post Letter
    • Get Post Letter History
    • Export Post Letter History
    • Calculate Price
    • Send Post Letter
    • Get List of Post Return Addresses
    • Create a Post Return Address
    • Delete Post Return Address
    • Get Post Return Address
    • Update Post Return Address
  • Postcards
    • Export Postcard History
    • Get Postcard History
    • Calculate Pricing
    • Send Postcard
  • Pricing
    • Get Country Pricing
  • Account Recharge
    • Get Credit Card info
    • Update Credit Card info
    • List of Packages
    • Purchase a Package
    • Get Transactions
    • Get a specific transaction
  • Referral Accounts
    • Get List of Referral Accounts
  • Reseller
    • Get Reseller Setting
    • Update Reseller Setting
    • Reseller By Subdomain
  • Reseller Accounts
    • List of Reseller Accounts
    • Create Reseller Account
    • Create Reseller Account - Public
    • Get Reseller Account
    • Update Reseller Account
    • Transfer Credit
  • SDK
    • SDK Download
  • Search
    • Search Contacts-Lists
  • SMS Campaigns
    • Get list of SMS Campaigns
    • Calculate Price for SMS Campaign
    • Use Short URL
    • Link Tracking Export
    • Link Statistics
    • Link Tracking
    • Get SMS Campaign
    • Update an SMS Campaign
    • Cancel an SMS Campaign
  • SMS
    • Cancel all Scheduled Messages
    • Export SMS History
    • Get all History
    • Get all Inbound SMS - Pull
    • Add a Test Inbound SMS
    • Mark all Inbound SMS as read
    • Mark a specific Inbound SMS as read
    • Get Specific Inbound - Pull
    • Calculate Price
    • Get all Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Delivery Receipts as read
    • Get a Specific Delivery Receipt
    • Send an SMS
    • Cancel a Scheduled Message
  • Email-to-SMS Allowed Address
    • List of Email-to-SMS Allowed Address
    • Create Email to SMS Allowed Address
    • Delete Email-to-SMS Allowed Address
    • Get specific Email-to-SMS Allowed Address
    • Update Email-to-SMS Allowed Address
  • Email-to-SMS Stripped Strings
    • List Stripped Strings
    • Create Stripped String
    • Delete Stripped String
    • Find Specific Stripped String
    • Update Stripped String
  • SMS Templates
    • List of Templates
    • Create a Template
    • Delete a Template
    • Update a Template
  • Statistics
    • Get SMS Statistics
    • Get Voice Statistics
  • Subaccounts
    • Get all Subaccounts
      GET
    • Create a new subaccount
      POST
    • Delete a specific subaccount
      DELETE
    • Get a specific subaccount
      GET
    • Update a specific subaccount
      PUT
    • Regenerate API Key
      PUT
  • Timezones
    • Get Timezones
  • Uploads
    • Upload a file
  • Voice
    • Cancel all Voice Calls
    • Export Voice History
    • Get Voice History
    • Voice Languages
    • Calculate Price
    • Get Voice receipts
    • Add a Test Delivery Receipt
    • Marked Voice Receipts as Read
    • Get Specific Voice Receipt
    • Send a Voice Call
    • Cancel a Specific Voice Call
  1. Subaccounts

Get all Subaccounts

GET
/subaccounts
Subaccounts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.clicksend.com/v3/subaccounts'
Response Response Example
{
    "data": {
        "current_page": 1,
        "data": [
            {
                "access_billing": 1,
                "access_contacts": 1,
                "access_email": 1,
                "access_fax": 1,
                "access_mms": 1,
                "access_post": 1,
                "access_reporting": 1,
                "access_reseller": 1,
                "access_settings": 1,
                "access_sms": 1,
                "access_users": 1,
                "access_voice": 1,
                "api_key": "E72D09F6-AC80-0A5C-F7F0-1A244A377A5C",
                "api_username": "johndoe",
                "email": "john@doe.com",
                "first_name": "John",
                "last_name": "Doe",
                "notes": null,
                "phone_number": "+13523944199",
                "share_campaigns": 0,
                "subaccount_id": 1
            },
            {
                "access_billing": 1,
                "access_contacts": 1,
                "access_email": 1,
                "access_fax": 1,
                "access_mms": 1,
                "access_post": 1,
                "access_reporting": 1,
                "access_reseller": 1,
                "access_settings": 1,
                "access_sms": 1,
                "access_users": 1,
                "access_voice": 1,
                "api_key": "B7825E96-6A67-1275-0F35-8DB8AC743B2C",
                "api_username": "name9Fb",
                "email": "testvT9@gmail.com",
                "first_name": "Firstname7JiPG",
                "last_name": "Lastname2olB1",
                "notes": null,
                "phone_number": "+19417516953",
                "share_campaigns": 0,
                "subaccount_id": 27
            },
            {
                "access_billing": 1,
                "access_contacts": 1,
                "access_email": 1,
                "access_fax": 1,
                "access_mms": 1,
                "access_post": 1,
                "access_reporting": 1,
                "access_reseller": 1,
                "access_settings": 1,
                "access_sms": 1,
                "access_users": 1,
                "access_voice": 1,
                "api_key": "D09BA7BC-546A-C951-6D3D-DAE3FEE6D848",
                "api_username": "nameLXD",
                "email": "testIiq@gmail.com",
                "first_name": "FirstnameSA3tA",
                "last_name": "Lastname22Pam",
                "notes": null,
                "phone_number": "+19417519130",
                "share_campaigns": 0,
                "subaccount_id": 28
            },
            {
                "access_billing": 1,
                "access_contacts": 1,
                "access_email": 1,
                "access_fax": 1,
                "access_mms": 1,
                "access_post": 1,
                "access_reporting": 1,
                "access_reseller": 1,
                "access_settings": 1,
                "access_sms": 1,
                "access_users": 1,
                "access_voice": 1,
                "api_key": "9415E584-794E-4F90-699D-7ECEF7290E51",
                "api_username": "nameh7m",
                "email": "testxQv.updated@gmail.com",
                "first_name": "Firstname5dgZw Updated",
                "last_name": "Lastname0voRd Updated",
                "notes": null,
                "phone_number": "+19417519640",
                "share_campaigns": 0,
                "subaccount_id": 29
            },
            {
                "access_billing": 1,
                "access_contacts": 1,
                "access_email": 1,
                "access_fax": 1,
                "access_mms": 1,
                "access_post": 1,
                "access_reporting": 1,
                "access_reseller": 1,
                "access_settings": 1,
                "access_sms": 1,
                "access_users": 1,
                "access_voice": 1,
                "api_key": "6E1491FC-797E-3011-1274-595EAFDE06EE",
                "api_username": "name5XC",
                "email": "testaLj.updated@gmail.com",
                "first_name": "FirstnameZcMSS Updated",
                "last_name": "LastnameDLmEB Updated",
                "notes": null,
                "phone_number": "+19417514461",
                "share_campaigns": 0,
                "subaccount_id": 30
            },
            {
                "access_billing": 1,
                "access_contacts": 1,
                "access_email": 1,
                "access_fax": 1,
                "access_mms": 1,
                "access_post": 1,
                "access_reporting": 1,
                "access_reseller": 1,
                "access_settings": 1,
                "access_sms": 1,
                "access_users": 1,
                "access_voice": 1,
                "api_key": "2C3B97DD-6C61-94BF-7886-9CA11DF550AF",
                "api_username": "franklinew5",
                "email": "frank@test.com",
                "first_name": "John",
                "last_name": "Doe",
                "notes": null,
                "phone_number": "+13108147982",
                "share_campaigns": 0,
                "subaccount_id": 47
            },
            {
                "access_billing": 1,
                "access_contacts": 1,
                "access_email": 1,
                "access_fax": 1,
                "access_mms": 1,
                "access_post": 1,
                "access_reporting": 1,
                "access_reseller": 1,
                "access_settings": 1,
                "access_sms": 1,
                "access_users": 1,
                "access_voice": 1,
                "api_key": "DE5F8C8F-E939-941B-C9E0-2BD542C3FFE3",
                "api_username": "franklinew6",
                "email": "frank@test.com",
                "first_name": "John",
                "last_name": "Doe",
                "notes": null,
                "phone_number": "+13108147982",
                "share_campaigns": 0,
                "subaccount_id": 48
            },
            {
                "access_billing": 1,
                "access_contacts": 1,
                "access_email": 0,
                "access_fax": 0,
                "access_mms": 0,
                "access_post": 0,
                "access_reporting": 1,
                "access_reseller": 0,
                "access_settings": 1,
                "access_sms": 0,
                "access_users": 1,
                "access_voice": 0,
                "api_key": "6279E8E9-8D02-72AE-9824-BF7C0C2E4FE7",
                "api_username": "franklinew7",
                "email": "frank@test.com",
                "first_name": "John",
                "last_name": "Doe",
                "notes": null,
                "phone_number": "+13108147982",
                "share_campaigns": 0,
                "subaccount_id": 49
            }
        ],
        "from": 1,
        "last_page": 1,
        "next_page_url": null,
        "per_page": 15,
        "prev_page_url": null,
        "to": 8,
        "total": 8
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "SUCCESS"
}

Request

None

Responses

🟢200OK
application/json
Body
object {0}
Previous
Get Voice Statistics
Next
Create a new subaccount
Built with