Home
API Reference

View subaccounts

post
https://api.smtp2go.com/v3/subaccounts/search

Returns any subaccounts that match search criteria

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean
Defaults to true

Determines if search terms match complete field values and are case sensitive (false) or partial fields and are case insensitive (true). Default: true

search_terms
array of strings

Return subaccounts with one or more of the strings in the following array.

Note: See 'fuzzy_search' for impact on case sensitivity

search_terms
string
Defaults to all

Controls which states you will be searched

Valid values:
all, active, closed, suspended

string
Defaults to asc

Sort direction, sorts either asc or desc by subaccount name

int32
Defaults to 100

Number of subaccounts to retrieve per call

string

A token provided by a prior call to this endpoint, passing this will cause it to fetch the next page of results

Responses

Updated 8 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago