Managed Accounts

Lists accounts managed by the current user.

Changed on

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

get/managed_accounts

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/managed_accounts
  • Auth
    HTTP bearer

Query parameters

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

{
  "email": {
    "contains": "john"
  },
  "organization_name": {
    "eq": "Example Company LLC"
  }
}
numberinteger

The page number to load

sizeinteger

The size of the page

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

sort'created_at' | 'email'
Example:email

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.
include_cancelled_accountsboolean
Example:true

Specifies if cancelled accounts should be included in the results.

Response

Successful response with a list of managed accounts.

Example response

{
  "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
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • a72569d69430Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • warning

      deleted the query request parameter page[number]

    • warning

      deleted the query request parameter page[size]

    • info

      added the new optional query request parameter page