跳到主要内容

List sub-organization plans

GET 

https://api.one.blendvision.com/bv/org/v1/sub-orgs/:id/plans

Lists the plans associated with a specific sub-organization within the main organization using the provided access token.


Required field(s):

  • id

  • Returns a 404/NotFound error if the requested resource is not found.
  • Returns a 400/BadRequest error if the request body is invalid.

Request

Path Parameters

    id stringrequired

    Required. The unique id of the sub-organization.

Header Parameters

    x-bv-org-id stringrequired

    To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Responses

A successful response.

Schema
    plans object[]
  • Array [
  • plan object
    id string

    Output only. The unique id of the plan.

    name string

    Output only. The name of the plan.

    type string

    Possible values: [PLAN_TYPE_GROUP, PLAN_TYPE_PLAN]

    Output only. The type of the plan.

    status string

    Possible values: [PLAN_STATUS_ABLE_TO_ASSIGNED]

    Output only. The status of the plan.

    description string

    Output only. The description of the plan.

    trial boolean

    Output only.

    group_plan object
    0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    created_at date-time

    Output only.

    updated_at date-time

    Output only.

    in_used boolean

    Output only. Indicates the plan is under used.

  • ]

Authorization: authorization

name: authorizationtype: apiKeydescription: Enter the token with Bearer schema prefix, eg. `Bearer <token-string>`in: header
curl -L 'https://api.one.blendvision.com/bv/org/v1/sub-orgs/:id/plans' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>'
Request Collapse all
Base URL
https://api.one.blendvision.com
Auth
Parameters
— pathrequired
— headerrequired
ResponseClear

Click the Send API Request button above and see the response here!