API-ReferenzGET

Workspaces auflisten

Listet die Workspaces auf, in denen RedReplier-Zugangsdaten handeln können, mit Rolle und Berechtigungen in jedem.

GEThttps://ai.redreplier.com/ai-app/api/v1/workspaces

Listet die Workspaces auf, in denen RedReplier-Zugangsdaten handeln können, mit Rolle und Berechtigungen in jedem.

Bearer-Token (RedReplier-API-Token)

Parameter

Dieser Endpoint hat keine Pfad- oder Query-Parameter.

Request-Body

Dieser Endpoint benötigt keinen JSON-Body.

Antwort

Gibt ein Objekt mit einem workspaces-Array zurück.

  • workspaces (Workspace[]): Workspaces, in denen diese Zugangsdaten handeln können.

Workspace-Objekt

  • id (string): Workspace-ID. Senden Sie sie im Header X-Workspace-Id, um in diesem Workspace zu handeln.
  • name (string): Name des Workspace.
  • organization ({ id, name }): Organisation, der der Workspace gehört.
  • role ({ key, name }): Ihre Rolle in diesem Workspace. key ist admin, editor, contributor oder viewer.
  • permissions (string[]): Berechtigungsschlüssel, die Sie in diesem Workspace haben, zum Beispiel redreplier.write.
  • isDefault (boolean): True für den Workspace, in dem ein Aufruf ohne Header X-Workspace-Id landet.
  • current (boolean): True für den Workspace, in dem dieser Aufruf gelandet ist.

Hinweise

Eine OAuth-Anmeldung, etwa über den Claude- oder ChatGPT-Connector, erreicht jeden Workspace, dem das Mitglied angehört, über Organisationen hinweg. Ein API-Schlüssel erreicht nur seinen eigenen Workspace, die Liste hat also einen Eintrag. Wählen Sie einen Workspace, indem Sie seine id bei jeder anderen Anfrage im Header X-Workspace-Id senden.

Fehler

  • 401 Unauthorized: Fehlendes oder ungültiges Bearer-Token, oder code: "token_issuer_lost_access", wenn die Person, die den API-Schlüssel erstellt hat, deaktiviert wurde oder den Workspace verlassen hat.
  • 403 Forbidden: code: "subscription_required", wenn der Tarif des Workspace keinen API-Zugang enthält, code: "workspace_access_denied", wenn X-Workspace-Id einen Workspace nennt, den diese Zugangsdaten nicht erreichen, oder code: "permission_denied", wenn Ihre Rolle im Workspace die Berechtigung redreplier.write nicht hat (Admin und Editor haben sie).
  • 429 Too Many Requests: Rate-Limit überschritten. Warten Sie die Sekunden aus Retry-After ab.
  • 500 Internal Server Error: Unerwarteter Serverfehler.
Beispielanfrage (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/workspaces \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "workspaces": [
    {
      "id": "acct_7dK9pQ2",
      "name": "Acme CRM",
      "organization": { "id": "org_01J8ZK4M2Q", "name": "Acme" },
      "role": { "key": "editor", "name": "Editor" },
      "permissions": ["workspace.read", "redreplier.write"],
      "isDefault": true,
      "current": true
    },
    {
      "id": "acct_3Hm8XwR",
      "name": "Northwind",
      "organization": { "id": "org_01J9P7T3XB", "name": "Northwind Studio" },
      "role": { "key": "viewer", "name": "Viewer" },
      "permissions": ["workspace.read"],
      "isDefault": false,
      "current": false
    }
  ]
}