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.

Schema

    data

    object[]

  • Array [

    • record_type stringrequired

    Possible values: [managed_account]

    Identifies the type of the resource.

    id UUIDrequired

    Uniquely identifies the managed account.

    email emailrequired

    The managed account's email.

    api_user stringrequired

    The manager account's email, which serves as the V1 API user identifier

    organization_name string

    The organization the managed account is associated with.

    manager_account_id stringrequired

    The ID of the manager account associated with the managed account.

    created_at stringrequired

    ISO 8601 formatted date indicating when the resource was created.

    updated_at stringrequired

    ISO 8601 formatted date indicating when the resource was updated.

    managed_account_allow_custom_pricing boolean

    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.

    rollup_billing boolean

    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

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

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

Loading...