Multi-Organization

The Multi-Organization Management feature is a powerful tool that allows you to perform actions for different organizations. This feature is particularly useful for users who manage multiple organizations and need to switch between them frequently.

How does it work?

The key to this feature is the organization's ID, a unique identifier for each organization. This ID can be obtained from the console or by contacting our support team.

Once you have the organization's ID, you can use it to perform actions on behalf of that organization. This is done by setting the x-bv-org-id header in your API requests. The x-bv-org-id header tells our system which organization you are acting on behalf of.

The x-bv-org-id header is used to specify the organization you wish to manage. By replacing your-organization-id with the actual ID of your organization, you can ensure that the request is correctly associated with your organization.

Here is an example in cURL:

curl --request GET \
  --url https://api.one.blendvision.com/bv/some-api \
  --header 'Accept: application/json' \
  --header 'authorization: Bearer <your-api-token>' \
  --header 'x-bv-org-id: <your-organization-id>'

Obtain Your Organization's ID

To get your current organization's ID, you can use the following API: GET /bv/org/v1/organizations

Here's an example of how to do this using cURL:

curl --request GET \
  --url https://api.one.blendvision.com/bv/org/v1/organizations \
  --header 'Accept: application/json' \
  --header 'authorization: Bearer <your-api-token>'

A successful response could be:

{
  "organization": {
    "id": "string",
    "name": "string",
    "parent_id": "string",
    "type": "ORGANIZATION_TYPE_BUSINESS",
    "status": "ORGANIZATION_STATUS_ACTIVATED",
    "description": "string",
    "owner_email": "string",
    "billing_cycle": 0,
    "contract_valid_start_time": "2019-08-24T14:15:22Z",
    "contract_months": 0,
    "contract_days": 0,
    "contract_valid_end_time": "2019-08-24T14:15:22Z",
    "has_sub_orgs": true,
    "parent_name": "string",
    "license_key": "string",
    "time_zone": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

The id field in the organization object is your organization's ID.

Which APIs support this feature?

Certain APIs support the multi-organization management feature. Please refer to API documentation to see if it supports this feature.