Lists accounts managed by the current user.

gethttps://api.telnyx.com/v2/managed_accounts

Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/managed_accounts?page[number]=1&page[size]=20"

Parameters

In Query
page[number]
integer
(1)
optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20
filter[email][contains]
string
optional
If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
Default:
"null"
filter[email][eq]
string
optional
If present, only returns results with the email matching exactly the value given.
Default:
"null"
sort
string
optional
Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:
  • email: sorts the result by the email field in ascending order.
  • -email: sorts the result by the email field in descending order.

If not given, results are sorted by created_at in descending order.
Default:
"created_at"
Example: "email"Options: [ "created_at", "email" ]
include_cancelled_accounts
boolean
optional
Specifies if cancelled accounts should be included in the results.
Default:
"false"
Example: "true"

Responses

200
Successful response with a list of managed accounts.
401
Unauthorized

Success Response

{
  "data": [
    {
      "api_key": "KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu",
      "api_token": "x6oexQNHTs-fZ7-QsDMOeg",
      "api_user": "[email protected]",
      "balance": {
        "available_credit": "400.00",
        "balance": "300.00",
        "credit_limit": "100.00",
        "currency": "USD",
        "record_type": "balance"
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "email": "[email protected]",
      "id": "f65ceda4-6522-4ad6-aede-98de83385123",
      "managed_account_allow_custom_pricing": true,
      "manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
      "organization_name": "Example Company LLC",
      "record_type": "managed_account",
      "rollup_billing": "boolean",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/managed_accounts

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/managed_accounts/{id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/managed_accounts/{id}

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/managed_accounts/{id}/actions/enable

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/managed_accounts/{id}/actions/disable

...

...

Parameters

Responses

Success Response

Previous:
IP Ranges
Next:
FQDNs
Was this page helpful?