SuperAI Flow Platform

Sections

Theme switcher

Get organization by ID

Retrieve detailed information for a specific organization.

Fetches complete metadata for a single organization using its unique identifier. Use this to verify organization existence, check active status, or retrieve organization details before performing related operations.

Context: - Returns organization regardless of active/inactive status - Does not include user count or related entity counts - Organization ID must be a valid UUID - Useful for verifying organization exists before user creation - Response includes audit timestamps

Behavior: 1. Validates organization_id is valid UUID format 2. Queries database for organization by ID 3. Returns organization if found 4. Raises 404 error if organization does not exist

Use Cases: - Verify organization exists before creating users - Check organization active status - Retrieve organization name for display purposes - Validate organization ID from external systems - Pre-operation existence checks

Related Endpoints: - GET /admin/organizations - List all organizations - PUT /admin/organizations/{id} - Update organization - GET /admin/organizations/{id}/users - List organization users - GET /admin/organizations/{id}/users/count - Count organization users

Header Parameters

Authorizationstring

Path Parameters

organization_idstring Required

Unique identifier of the organization to retrieve. Must be a valid UUID format.

Response

200
Object
Organization details 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}

400
Object
Invalid UUID format in path parameter

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
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
404
Object
Organization with specified ID does not exist

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
422
Object
Validation Error

Response Attributes

detailarray

Show child attributes

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