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
-
email
: sorts the result by theemail
field in ascending order. -
-email
: sorts the result by theemail
field in descending order.
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
Default value: null
If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
Default value: null
If present, only returns results with the email
matching exactly the value given.
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.
Default value: null
If present, only returns results with the organization_name
matching exactly the value given.
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:
If not given, results are sorted by
created_at
Default value: false
Specifies if cancelled accounts should be included in the results.
Responses
200: Successful response with a list of managed accounts.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
Possible values: [managed_account
]
Identifies the type of the resource.
Uniquely identifies the managed account.
The managed account's email.
The manager account's email, which serves as the V1 API user identifier
The organization the managed account is associated with.
The ID of the manager account associated with the managed account.
ISO 8601 formatted date indicating when the resource was created.
ISO 8601 formatted date indicating when the resource was updated.
Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect.
Boolean value that indicates if the billing information and charges to the managed account "roll up" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false.
meta
object
{
"data": [
{
"record_type": "managed_account",
"id": "f65ceda4-6522-4ad6-aede-98de83385123",
"email": "[email protected]",
"api_user": "[email protected]",
"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
}
}
401: Unauthenticated response. Happens when the current user cannot be authenticated.