List all groups
Lists all the groups from all the organizations in a Frontier instance. It can be filtered by organization and state.
Query Parameters
The organization id to filter by.
The state to filter by. It can be enabled or disabled.
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
Schema
- Array [
- Array [
- ]
- ]
groups object[]
The time the group was created.
The time the group was last updated.
users object[]
Unique name of the user.
Name of the user.
The time the user was created.
The time the user was last updated.
The state of the user (enabled or disabled).
The base64 encoded image string of the user avatar. Should be less than 2MB.
The number of members explicitly added in the project.
{
"groups": [
{
"id": "string",
"name": "string",
"title": "string",
"org_id": "string",
"metadata": {},
"created_at": "2023-06-07T05:39:56.961Z",
"updated_at": "2023-06-07T05:39:56.961Z",
"users": [
{
"id": "string",
"name": "johndoe",
"title": "John Doe",
"email": "string",
"metadata": {},
"created_at": "2023-06-07T05:39:56.961Z",
"updated_at": "2023-06-07T05:39:56.961Z",
"state": "enabled",
"avatar": "string"
}
],
"members_count": 2
}
]
}
Bad Request - The request was malformed or contained invalid parameters.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}