List organizations
Returns a list of organizations. It can be filtered by userID or organization state.
Query Parameters
The user ID to filter by. It can be used to list all the organizations that the user is a member of. Otherwise, all the organizations in the Frontier instance will be listed.
The state to filter by. It can be enabled
or disabled
.
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
Schema
- Array [
- ]
organizations object[]
The time the organization was created.
The time the organization was last updated.
The state of the organization (enabled or disabled).
The base64 encoded image string of the organization avatar. Should be less than 2MB.
{
"organizations": [
{
"id": "string",
"name": "string",
"title": "string",
"metadata": {},
"created_at": "2023-06-07T05:39:56.961Z",
"updated_at": "2023-06-07T05:39:56.961Z",
"state": "enabled",
"avatar": "string"
}
]
}
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"
}
]
}