SuperAI Flow Platform

Sections

Theme switcher

List all organizations

Retrieve all organizations across the entire platform.

Returns a complete list of all organizations in the system, regardless of active status. Use this for administrative oversight, reporting, and organization management tasks.

Context: - Returns both active and inactive organizations - Includes organization metadata (creation date, modification date) - Each organization represents an isolated tenant in the system - Organizations are the top-level entity for user and flow grouping - No pagination implemented yet (suitable for < 1000 organizations)

Behavior: 1. Queries all organizations from database 2. Orders results by creation date (newest first) 3. Returns complete list without filtering

Performance Notes: - Current implementation loads all organizations in memory - Suitable for platforms with < 1000 organizations - For larger datasets, pagination should be implemented

Use Cases: - Admin dashboard showing all organizations - Organization management interfaces - Reporting and analytics on organization count - Audit and compliance reviews

Related Endpoints: - POST /admin/organizations - Create new organization - GET /admin/organizations/{id} - Get single organization details - PATCH /admin/organizations/{id}/deactivate - Deactivate organization

Header Parameters

Authorizationstring

Response

200
Object
List of all organizations retrieved successfully

Response Attributes

created_atstring Required

Timestamp when organization was created. Format: ISO 8601 UTC (e.g., '2025-01-23T15:30:00Z').

idstring Required

Unique identifier for the organization. Format: UUID v4

is_activeboolean

Whether the organization is active. Active organizations allow user logins and flow executions. Inactive organizations are read-only; users cannot log in. Set via PUT /admin/organizations/{id} or PATCH /deactivate endpoint.

Default value
true
modified_atstring Required

Timestamp when organization was last modified. Updated automatically on any field change. Format: ISO 8601 UTC (e.g., '2025-01-24T10:45:00Z'). Used for change tracking and audit logs.

namestring Required

Organization display name. Unique across the platform. Used in UI, reports, and organization selection. Can be updated via PUT /admin/organizations/{id}

403
Object
Forbidden - Insufficient permissions to access this resource

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
500
Object
Internal Server Error - An unexpected error occurred

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot