List organizations
Returns a list of organizations. It can be filtered by userID or organization state.
Query Parameters
user_id string
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.
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
organizations object[]
{
"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
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"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[]
{
"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[]
{
"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[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
GET /v1beta1/organizations
Authorization
name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic
Request
Request
curl / cURL
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'
python / requests
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'
go / native
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'
nodejs / axios
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'
ruby / Net::HTTP
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'
csharp / RestSharp
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'
php / cURL
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'
java / OkHttp
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'
powershell / RestMethod
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'