Get group
GEThttps://us.east1.api.komodowellbeing.com/rest/v1/groups/:group_id
Get a group in the current organisation
Request
Path Parameters
group_id numberrequired
The ID of the group
Responses
- 200
- 400
- 401
- 404
- 500
OK
- application/json
- Schema
- Example (auto)
Schema
idnumber
The group's ID in Komodo Wellbeing
namestring
The name of the group
typestring
The group's type
Possible values: [REGISTRATION, YEAR, HOUSE, BOARDING, COURSE, MISC, USER, CAMPUS]
created_atdate-time
When the group was created
{
"id": 0,
"name": "string",
"type": "REGISTRATION",
"created_at": "2024-07-29T15:51:28.071Z"
}
Bad request data
- application/json
- Schema
- Example (auto)
Schema
statusnumber
messagestring
{
"status": 0,
"message": "string"
}
Invalid authentication
- application/json
- Schema
- Example (auto)
Schema
statusnumber
messagestring
{
"status": 0,
"message": "string"
}
The specified resource was not found
- application/json
- Schema
- Example (auto)
Schema
statusnumber
messagestring
{
"status": 0,
"message": "string"
}
Something went wrong processing the request
- application/json
- Schema
- Example (auto)
Schema
statusnumber
messagestring
{
"status": 0,
"message": "string"
}
Authorization: x-api-key
name: x-api-keytype: apiKeyin: header
name: BearerAuthtype: httpscheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://us.east1.api.komodowellbeing.com/rest/v1/groups/:group_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
request.Headers.Add("Authorization", "Bearer <x-api-key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());