List all organizations
Lists all the organizations in a Frontier instance. It can be filtered by user and state.
Query Parameters
user_id string
The user id to filter by.
state string
The state to filter by. It can be enabled or disabled.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
organizations object[]
id string
name string
title string
metadata object
created_at date-time
The time the organization was created.
updated_at date-time
The time the organization was last updated.
state string
The state of the organization (enabled or disabled).
avatar string
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.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@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
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@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
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Loading...