Organizations

Organisationen sind die Entitäten der obersten Ebene in Capgo. Sie ermöglichen Ihnen, Apps, Teammitglieder und Ressourcen unter einem einzigen Dach zu gruppieren. Jede Organisation kann mehrere Mitglieder mit unterschiedlichen Rollen und Berechtigungen haben.

Häufige Anwendungsfälle

• Erstellen einer neuen Organisation für Ihr Unternehmen
• Organisationseinstellungen verwalten
• Aktualisierung der Organisationsinformationen
• Abrufen von Organisationsdetails

Endpunkte

GET

https://api.capgo.app/organization/

Rufen Sie Organisationsinformationen ab. Wenn orgId in den Parametern angegeben ist, wird eine einzelne Organisation zurückgegeben. Andernfalls werden alle zugänglichen Organisationen zurückgegeben.

Abfrageparameter

• orgId (optional): Die ID der spezifischen abzurufenden Organisation

Antworttyp

interface Organization {
  id: string
  created_by: string
  created_at: string
  updated_at: string
  logo: string | null
  name: string
  management_email: string
  customer_id: string | null
}

Beispielanfrage

# Get all organizations
curl -H "authorization: your-api-key" https://api.capgo.app/organization/

# Get specific organization
curl -H "authorization: your-api-key" https://api.capgo.app/organization/?orgId=org_123

Beispielantwort

{
  "data": {
    "id": "org_123",
    "name": "My Company",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "logo": "https://example.com/logo.png",
    "management_email": "admin@example.com",
    "customer_id": "cus_123"
  }
}

POST

https://api.capgo.app/organization/

Erstellen Sie eine neue Organisation.

Anforderungstext

interface OrganizationCreate {
  name: string
}

Beispielanfrage

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Organization"
  }' \
  https://api.capgo.app/organization/

Beispielantwort

{
  "status": "Organization created",
  "id": "org_456"
}

PUT

https://api.capgo.app/organization/

Aktualisieren Sie eine vorhandene Organisation. Erfordert die Rolle eines Administrators.

Anforderungstext

interface OrganizationUpdate {
  orgId: string
  logo?: string
  name?: string
  management_email?: string
}

Beispielanfrage

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "orgId": "org_123",
    "name": "New Company Name",
    "management_email": "newemail@example.com"
  }' \
  https://api.capgo.app/organization/

Beispielantwort

{
  "status": "Organization updated",
  "data": {
    "id": "org_123",
    "name": "New Company Name",
    "management_email": "newemail@example.com"
  }
}

LÖSCHEN

https://api.capgo.app/organization/

Löschen Sie eine vorhandene Organisation. Erfordert die Rolle eines Administrators. Diese Aktion ist irreversibel und entfernt alle zugehörigen Apps, Bundles (Versionen) und Ressourcen.

Abfrageparameter

• orgId: Die ID der zu löschenden Organisation

Beispielanfrage

curl -X DELETE \
  -H "authorization: your-api-key" \
  https://api.capgo.app/organization/?orgId=org_123

Beispielantwort

{
  "status": "Organization deleted",
  "id": "org_123"
}

Fehlerbehandlung

Häufige Fehlerszenarien und ihre Antworten:

// Invalid API key
{
  "error": "Invalid API key",
  "status": "KO"
}

// Missing required field
{
  "error": "Name is required",
  "status": "KO"
}

// Insufficient permissions
{
  "error": "Admin role required",
  "status": "KO"
}

Bewährte Methoden

1. Benennung: Verwenden Sie klare, aussagekräftige Namen für Organisationen
2. Rollen: Weisen Sie den Teammitgliedern entsprechende Rollen zu
3. E-Mail: Verwenden Sie eine Gruppen-E-Mail für „management_email“, um Probleme mit persönlichen E-Mail-Änderungen zu vermeiden
4. Logo: Hosten Sie Logos auf einem zuverlässigen CDN und verwenden Sie HTTPS-URLs