Skip to main content

List sub-organizations in an organization

GET 
/bv/org/v1/sub-orgs

Lists the sub-organizations within an organization using the provided access token.

Request​

Query Parameters

    current_page int32

    Input only. Indicates the current page to shows. Default: 1

    items_per_page int32

    Input only. Indicates the number of items to shows per page. Default: 1. Max: 100.

    name string

    Input only. To list the sub-orgs that contains the name in the results.

    types string[]

    Possible values: [ORGANIZATION_TYPE_ROOT, ORGANIZATION_TYPE_GENERAL_DISTRIBUTOR, ORGANIZATION_TYPE_RESELLER, ORGANIZATION_TYPE_BUSINESS]

    Input only. To list the sub-orgs that contains the list of types in the results.

    statuses string[]

    Possible values: [ORGANIZATION_STATUS_ACTIVATED, ORGANIZATION_STATUS_VERIFYING, ORGANIZATION_STATUS_FAIL_TO_VERIFY, ORGANIZATION_STATUS_DEACTIVATED, ORGANIZATION_STATUS_DELETING, ORGANIZATION_STATUS_DELETED, ORGANIZATION_STATUS_ACTIVATION_SCHEDULED]

    Input only. To list the sub-orgs that contains the list of statuses in the results.

    • ORGANIZATION_STATUS_ACTIVATED: The Organization is activated.
    • ORGANIZATION_STATUS_VERIFYING: The Organization is created but awaiting the owner to verify.
    • ORGANIZATION_STATUS_FAIL_TO_VERIFY: The Organization failed to verify since the invitation is expired.
    • ORGANIZATION_STATUS_DEACTIVATED: The Organization is deactivated since the contract is expired or manually changed by the parent admin.
    • ORGANIZATION_STATUS_DELETING: The Organization is awaiting related resources deleted.
    • ORGANIZATION_STATUS_DELETED: The Organization is deleted.
    • ORGANIZATION_STATUS_ACTIVATION_SCHEDULED: The Organization is activation scheduled since the first contract is not start.

Responses​

A successful response.

Schema
    organizations object[]
  • Array [
    • id string

    Output only. The resource identifier of the organization.

    name string

    Output only. The name of the organization.

    parent_id string

    Output only. The appended parent organization id.

    type string

    Possible values: [ORGANIZATION_TYPE_ROOT, ORGANIZATION_TYPE_GENERAL_DISTRIBUTOR, ORGANIZATION_TYPE_RESELLER, ORGANIZATION_TYPE_BUSINESS]

    Output only. Indicates the type of the organization.

    status string

    Possible values: [ORGANIZATION_STATUS_ACTIVATED, ORGANIZATION_STATUS_VERIFYING, ORGANIZATION_STATUS_FAIL_TO_VERIFY, ORGANIZATION_STATUS_DEACTIVATED, ORGANIZATION_STATUS_DELETING, ORGANIZATION_STATUS_DELETED, ORGANIZATION_STATUS_ACTIVATION_SCHEDULED]

    Output only. Indicates the status of the organization.

    description string

    Output only. The description of the organization.

    owner_email string

    Output only. The owner email of the organization.

    billing_cycle int32

    Output only. The billing cycle of the organization.

    contract_valid_start_time date-time

    Output only. The contract valid start day won't be valid before the day.

    contract_months int32

    Output only. The contract duration unit. It might one of the contract_months or contract_days.

    contract_days int32

    Output only. The contract duration unit. It might one of the contract_months or contract_days.

    contract_valid_end_time date-time

    Output only. The contract valid end day won't be valid after the day.

    next_contract object

    Output only. The next contract of the organization.

    start_time date-time

    Output only. The start time of the organization.

    months int32

    Output only. The months of the organization.

    days int32

    Output only. The days of the organization.

    end_time date-time

    Output only. The valid end time of the organization.

    parent_id string

    Output only. The parent id of the organization.

    plan_id string

    Output only. The plan id of the organization.

    has_sub_orgs boolean

    Output only. Indicates there are sub-organizations appended to the organization.

    parent_name string

    Output only. The name of appended parent organization.

    license_key string

    Output only.

    time_zone string

    Output only. The time zone of the organization.

    owner object
    id string

    Output only. The unique id of the user.

    email string

    Output only. The email of the user.

    status string

    Possible values: [ACCOUNT_STATUS_ACTIVATED, ACCOUNT_STATUS_DEACTIVATED]

    Output only. The status of the user.

    role_type string

    Possible values: [ROLE_TYPE_OWNER, ROLE_TYPE_ADMIN, ROLE_TYPE_STAFF, ROLE_TYPE_DEVELOPER, ROLE_TYPE_CONTENT_CONTRIBUTOR]

    Output only. The role of the user.

    created_at date-time

    Output only. The created time of the user.

    first_name string

    Output only. The first name of the user.

    last_name string

    Output only. The last name of the user.

    created_at date-time

    Output only.

    updated_at date-time

    Output only.

  • ]
    • pagination object
    total_items int32

    Output only. The total numbers of the list in the current pagination.

    items_per_page int32

    Output only. The number of items per page in the current pagination.

    current_page int32

    Output only. The current page in the current pagination.

Loading...