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

200

A successful response.

application/json

Schema

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. NOTE This property is deprecated, use username instead.
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, ROLE_TYPE_CUSTOM]
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.
role_id string
Output only. The id of role.
account_type string
Possible values: [ACCOUNT_TYPE_EMAIL, ACCOUNT_TYPE_NON_EMAIL]
Output only. The type of the account (email or non-email).
username string
Output only. The user name to identify the user.
contact_email string
Output only. The user's contact email address.
business_setting object
business_plan_type string
Possible values: [BUSINESS_PLAN_TYPE_BVONE, BUSINESS_PLAN_TYPE_CXM, BUSINESS_PLAN_TYPE_CPM]
Output only. The plan type of the business sub-organization. Values:
• BUSINESS_PLAN_TYPE_BVONE: Indicates the BVOne plan, allowing the business sub-organization to create sites and enable custom domains.
• BUSINESS_PLAN_TYPE_CXM: Indicates the CXM plan, allowing add the marketplace url and marketplace id.
category Optional. The category of the business sub-organization. This field is optional and can contain custom classifications. Max length: 40 (string)
tax_id Optional. The tax ID of the business sub-organization. Max length: 8 (string)
enable_create_site boolean
Optional. Indicates whether the business sub-organization has permission to create sites. This field should only be provided when the business sub-organization plan is BVOne plan. If not set, the default value is false.
site_limit int32
Optional. The maximum number of sites that the business sub-organization can create. This field should only be provided when the business sub-organization plan is BVOne plan. This field is optional and must be within the range of 1 to 50, inclusive. Default value is 1.
enable_custom_domain boolean
Optional. Indicates if the business sub-organization can enable a custom domain. This field should only be provided when the business sub-organization plan is BVOne plan. If not set, the default value is false.
marketplace_url string
Deprecated. use template.marketplace_url instead. Optional. The marketplace URL of the business sub-organization. This field should only be provided when the business sub-organization plan is CXM plan. Max length: 2000, must be a valid URL format.
marketplace_id string
Deprecated. use template.marketplace_id instead. Optional. Associate the marketplace ID with the business sub-organization. This field should only be provided when the business sub-organization plan is CXM plan.
single_device_login boolean
Optional. Enable single device login restriction for users in this organization. false means unlimited devices can be logged in simultaneously. true means only one device can be logged in at a time (oldest login will be kicked out by new login). Default value is false (unlimited devices).
logo object
Output only. The logo of org.
library_id stringrequired
Required. The identifier of library.
url string
Output Only. The cdn url of library.
template_id string
Deprecated: Use template instead. Output only. The template ID of the organization returns empty when not set.
template object
Output only. The template of the organization returns null when not set.
id string
name string
enterprise_id string
Output only. The enterprise id of the organization.
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.

Example (from schema)

{
  "organizations": [
    {
      "id": "string",
      "name": "string",
      "parent_id": "string",
      "type": "ORGANIZATION_TYPE_ROOT",
      "status": "ORGANIZATION_STATUS_ACTIVATED",
      "description": "string",
      "owner_email": "string",
      "billing_cycle": 0,
      "contract_valid_start_time": "2024-07-29T15:51:28.071Z",
      "contract_months": 0,
      "contract_days": 0,
      "contract_valid_end_time": "2024-07-29T15:51:28.071Z",
      "next_contract": {
        "start_time": "2024-07-29T15:51:28.071Z",
        "months": 0,
        "days": 0,
        "end_time": "2024-07-29T15:51:28.071Z",
        "parent_id": "string",
        "plan_id": "string"
      },
      "has_sub_orgs": true,
      "parent_name": "string",
      "license_key": "string",
      "time_zone": "string",
      "owner": {
        "id": "string",
        "email": "string",
        "status": "ACCOUNT_STATUS_ACTIVATED",
        "role_type": "ROLE_TYPE_OWNER",
        "created_at": "2024-07-29T15:51:28.071Z",
        "first_name": "string",
        "last_name": "string",
        "role_id": "string",
        "account_type": "ACCOUNT_TYPE_EMAIL",
        "username": "string",
        "contact_email": "string"
      },
      "business_setting": {
        "business_plan_type": "BUSINESS_PLAN_TYPE_BVONE",
        "category": "string",
        "tax_id": "string",
        "enable_create_site": true,
        "site_limit": 0,
        "enable_custom_domain": true,
        "marketplace_url": "string",
        "marketplace_id": "string",
        "single_device_login": true
      },
      "logo": {
        "library_id": "string",
        "url": "string"
      },
      "template_id": "string",
      "template": {
        "id": "string",
        "name": "string"
      },
      "enterprise_id": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "pagination": {
    "total_items": 0,
    "items_per_page": 0,
    "current_page": 0
  }
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...