Get group
GEThttps://api.one.blendvision.com/bv/org/v1/groups/:id
Fetches details of a specific group within the 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
Required. The unique id of the group.
Header Parameters
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
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
group object
{
"group": {
"id": "string",
"name": "string",
"description": "string",
"creator_name": "string",
"user_infos": [
{
"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"
}
],
"members": 0,
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}
}
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
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A unauthenticated response.
The header authorization
was missing or unidentified.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A forbidden response.
It means that the provided authorization
did not have enough permission to access the resource or the API.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A server error response. There are more HTTP status code mappings listed on here.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Authorization: authorization
name: authorizationtype: apiKeydescription: Enter the token with Bearer schema prefix, eg. `Bearer <token-string>`in: header
- curl
- python
- go
- nodejs
- php
- CURL
curl -L 'https://api.one.blendvision.com/bv/org/v1/groups/:id' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>'