Get group

Get group

Path Parameters

orgId string required
id string required

Query Parameters

withMembers boolean

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

group object
id string
name string
title string
orgId string
metadata object
createdAt date-time
The time the group was created.
updatedAt date-time
The time the group was last updated.
users object[]
Array [
id string
name can either be empty or must start with a character
Unique name of the user.
title string
Name of the user.
email string
metadata object
createdAt date-time
The time the user was created.
updatedAt date-time
The time the user was last updated.
state string
The state of the user (enabled or disabled).
avatar string
The base64 encoded image string of the user avatar. Should be less than 2MB.
]

{
  "group": {
    "id": "string",
    "name": "string",
    "title": "string",
    "orgId": "string",
    "metadata": {},
    "createdAt": "2023-06-07T05:39:56.961Z",
    "updatedAt": "2023-06-07T05:39:56.961Z",
    "users": [
      {
        "id": "string",
        "name": "johndoe",
        "title": "John Doe",
        "email": "string",
        "metadata": {},
        "createdAt": "2023-06-07T05:39:56.961Z",
        "updatedAt": "2023-06-07T05:39:56.961Z",
        "state": "enabled",
        "avatar": "string"
      }
    ]
  }
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Loading...