get__settings_organization

GET /settings/organization

Get Organization Settings

Retrieve the current user's organization settings. The user must be authenticated and associated with an organization to access these settings.

TypeScript Client Library

// Using the Flashback TypeScript client
import { FlashbackClient } from '@flashback/client';

const client = new FlashbackClient({ accessToken: 'your-access-token' });

// Get organization settings
try {
  const result = await client.settings.organization.get();
  console.log('Organization settings:', result);
} catch (error) {
  console.error('Failed to get organization settings:', error);
}

Code Samples

# You can also use wget
curl -X GET https://backend.flashback.tech/settings/organization \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "success": true,
  "settings": {
    "defaultStorageType": "S3",
    "maxFileSize": "10GB",
    "retentionPolicy": {
      "enabled": true,
      "days": 365
    },
    "security": {
      "requireMFA": true,
      "sessionTimeout": 3600
    }
  }
}

404 Response

{
  "success": false,
  "message": "User not associated with any organization"
}

500 Response

{
  "success": false,
  "message": "Internal server error",
  "error": "Database connection failed"
}

Responses

Status
Meaning
Description
Schema

200

Organization settings retrieved successfully

Inline

404

User not associated with organization

Inline

500

Internal server error

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

true

none

Indicates if the request was successful

» settings

object

true

none

Organization settings object containing key-value pairs

Status Code 404

Name
Type
Required
Restrictions
Description

» success

boolean

true

none

Always false for error responses

» message

string

true

none

Error message describing the issue

Status Code 500

Name
Type
Required
Restrictions
Description

» success

boolean

true

none

Always false for error responses

» message

string

true

none

Error message describing the issue

» error

string

false

none

Additional error details if available

DTOs

GetSettingsResponse

export interface GetSettingsResponse {
  success: boolean;
  // Using Record<string, any> for maximum flexibility - settings can contain any JSON-serializable data
  settings: Record<string, any>;
}

SettingsErrorResponse

export interface SettingsErrorResponse {
  success: false;
  message: string;
  error?: string;
}

Last updated

Was this helpful?