Skip to content

get organization

GET
/api/v1/organizations

Controller:

github.com/raghavyuva/nixopus-api/internal/features/organization/controller.(*OrganizationsController).GetOrganization

Middlewares:

  • github.com/go-fuego/fuego.defaultLogger.middleware
  • github.com/raghavyuva/nixopus-api/internal/routes.(*Router).SetupRoutes.(*Router).setupAuthentication.func2
  • github.com/raghavyuva/nixopus-api/internal/routes.(*Router).applyMiddleware.func1
  • github.com/raghavyuva/nixopus-api/internal/routes.(*Router).applyMiddleware.func3

Parameters

Header Parameters

Accept
Typestring

Responses

OK
JSON
{
"data": {
"created_at": "string",
"deleted_at": "string",
"description": "string",
"id": null,
"name": "string",
"updated_at": "string",
"users": [
{
"avatar": "string",
"created_at": "string",
"deleted_at": "string",
"email": "string",
"id": null,
"is_verified": true,
"organization_users": [
{
"created_at": "string",
"deleted_at": "string",
"id": null,
"organization": {
"created_at": "string",
"deleted_at": "string",
"description": "string",
"id": null,
"name": "string",
"updated_at": "string",
"users": [
"[Circular Reference]"
]
},
"organization_id": null,
"updated_at": "string",
"user": {
"avatar": "string",
"created_at": "string",
"deleted_at": "string",
"email": "string",
"id": null,
"is_verified": true,
"organization_users": [
{
"created_at": "string",
"deleted_at": "string",
"id": null,
"organization": {
"created_at": "string",
"deleted_at": "string",
"description": "string",
"id": null,
"name": "string",
"updated_at": "string",
"users": [
"[Circular Reference]"
]
},
"organization_id": null,
"updated_at": "string",
"user": "[Circular Reference]",
"user_id": null
}
],
"organizations": [
{
"created_at": "string",
"deleted_at": "string",
"description": "string",
"id": null,
"name": "string",
"updated_at": "string",
"users": [
"[Circular Reference]"
]
}
],
"supertokens_user_id": "string",
"two_factor_enabled": true,
"two_factor_secret": "string",
"type": "string",
"updated_at": "string",
"username": "string"
},
"user_id": null
}
],
"organizations": [
{
"created_at": "string",
"deleted_at": "string",
"description": "string",
"id": null,
"name": "string",
"updated_at": "string",
"users": [
"[Circular Reference]"
]
}
],
"supertokens_user_id": "string",
"two_factor_enabled": true,
"two_factor_secret": "string",
"type": "string",
"updated_at": "string",
"username": "string"
}
]
},
"message": "string",
"status": "string"
}

Samples

cURL
curl -X GET http://localhost/api/v1/organizations
JavaScript
fetch("http://localhost/api/v1/organizations")
  .then(response => response.json())
  .then(data => console.log(data));
PHP
file_get_contents("http://localhost/api/v1/organizations");
Python
import requests
response = requests.get("http://localhost/api/v1/organizations")
print(response.json())
Powered by VitePress OpenAPI

Made with love
Released under the Functional Source License (FSL)