Skip to main content

Lists accounts managed by the current user.

GET 
/managed_accounts

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

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[email][contains] string

    Default value: null

    If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

    filter[email][eq] string

    Default value: null

    If present, only returns results with the email matching exactly the value given.

    filter[organization_name][contains] string

    Default value: null

    If present, only returns results with the organization_name containing the given value. Matching is not case-sensitive. Requires at least three characters.

    filter[organization_name][eq] string

    Default value: null

    If present, only returns results with the organization_name matching exactly the value given.

    sort string

    Possible values: [created_at, email]

    Default value: created_at

    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.
    include_cancelled_accounts boolean

    Default value: false

    Specifies if cancelled accounts should be included in the results.

Responses

200: Successful response with a list of managed accounts.

401: Unauthenticated response. Happens when the current user cannot be authenticated.

Request samples


curl -L 'https://api.telnyx.com/v2/managed_accounts' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


{
"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
}
}