API-referentieGET

Workspaces weergeven

Geef de workspaces weer waarin inloggegevens van RedReplier kunnen werken, met de rol en permissies in elke workspace.

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

Geef de workspaces weer waarin inloggegevens van RedReplier kunnen werken, met de rol en permissies in elke workspace.

Bearer-token (RedReplier API-token)

Authenticatie

Stuur een RedReplier API-token of een OAuth-toegangstoken mee als Bearer-token. Dit endpoint is open voor elke geldige sleutel.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parameters

Dit endpoint heeft geen pad- of queryparameters.

Request body

Dit endpoint heeft geen JSON-body nodig.

Respons

Geeft een object terug met een array workspaces.

  • workspaces (Workspace[]): Workspaces waarin deze inloggegevens kunnen werken.

Workspace-object

  • id (string): ID van de workspace. Stuur het mee in de header X-Workspace-Id om in deze workspace te werken.
  • name (string): Naam van de workspace.
  • organization ({ id, name }): Organisatie die eigenaar is van de workspace.
  • role ({ key, name }): Je rol in deze workspace. key is admin, editor, contributor of viewer.
  • permissions (string[]): Permissiesleutels die je in deze workspace hebt, zoals redreplier.write.
  • isDefault (boolean): True voor de workspace waar een aanroep terechtkomt als je geen header X-Workspace-Id meestuurt.
  • current (boolean): True voor de workspace waar deze aanroep terechtkwam.

Voorbeeldverzoek

curl -s https://ai.redreplier.com/ai-app/api/v1/workspaces \
  -H 'Authorization: Bearer redreplier_test_1234567890'

Opmerkingen

Een OAuth-login, zoals de connector voor Claude of ChatGPT, kan bij elke workspace waar het lid toe behoort, ook over organisaties heen. Een API-sleutel kan alleen bij de eigen workspace, dus de lijst heeft één item. Kies een workspace door het id ervan mee te sturen in de header X-Workspace-Id bij elk ander verzoek.

Fouten

  • 401 Unauthorized: Bearer-token ontbreekt of is ongeldig, of code: "token_issuer_lost_access" als de persoon die de API-sleutel heeft aangemaakt is gedeactiveerd of de workspace heeft verlaten.
  • 403 Forbidden: code: "subscription_required" als het abonnement van de workspace geen API-toegang bevat, code: "workspace_access_denied" als X-Workspace-Id een workspace noemt waar deze inloggegevens geen toegang toe hebben, of code: "permission_denied" als je rol in de workspace geen redreplier.write heeft (Admin en Editor hebben die wel).
  • 429 Too Many Requests: Rate limit overschreden. Wacht het aantal seconden uit Retry-After.
  • 500 Internal Server Error: Onverwachte serverfout.
Voorbeeldverzoek (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
    }
  ]
}