Skip to main content
GET
/
managed_accounts
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const managedAccounts = await client.managedAccounts.list();

console.log(managedAccounts.data);
{
  "data": [
    {
      "record_type": "managed_account",
      "id": "f65ceda4-6522-4ad6-aede-98de83385123",
      "email": "user@example.com",
      "api_user": "managed_account@example.com",
      "organization_name": "Example Company LLC",
      "manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "managed_account_allow_custom_pricing": true,
      "rollup_billing": false
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
filter
object

Consolidated filter parameter (deepObject style). Originally: filter[email][contains], filter[email][eq], filter[organization_name][contains], filter[organization_name][eq]

Example:
{
  "email": { "contains": "john" },
  "organization_name": { "eq": "Example Company LLC" }
}
​
page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

​
sort
enum<string>
default:created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>

<li> <code>email</code>: sorts the result by the <code>email</code> field in ascending order. </li> <li> <code>-email</code>: sorts the result by the <code>email</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
Available options:
created_at,
email
Example:

"email"

​
include_cancelled_accounts
boolean
default:false

Specifies if cancelled accounts should be included in the results.

Example:

true

Response

Successful response with a list of managed accounts.

​
data
ManagedAccount · object[]
​
meta
object