Référence de l'APIGET

Lister les espaces de travail

Liste les espaces de travail dans lesquels des identifiants RedReplier peuvent agir, avec le rôle et les permissions de chacun.

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

Liste les espaces de travail dans lesquels des identifiants RedReplier peuvent agir, avec le rôle et les permissions de chacun.

Jeton Bearer (jeton API RedReplier)

Paramètres

Cet endpoint ne prend pas de paramètres de chemin ni de requête.

Corps de la requête

Cet endpoint ne nécessite pas de corps JSON.

Réponse

Renvoie un objet avec un tableau workspaces.

  • workspaces (Workspace[]) : Espaces de travail dans lesquels ces identifiants peuvent agir.

Objet Workspace

  • id (string): ID de l’espace de travail. Envoyez-le dans l’en-tête X-Workspace-Id pour agir dans cet espace de travail.
  • name (string): Nom de l’espace de travail.
  • organization ({ id, name }): Organisation propriétaire de l’espace de travail.
  • role ({ key, name }): Votre rôle dans cet espace de travail. key vaut admin, editor, contributor ou viewer.
  • permissions (string[]): Clés de permission que vous détenez dans cet espace de travail, par exemple redreplier.write.
  • isDefault (boolean): True pour l’espace de travail dans lequel un appel aboutit sans en-tête X-Workspace-Id.
  • current (boolean): True pour l’espace de travail dans lequel cet appel a abouti.

Notes

Une connexion OAuth, comme le connecteur Claude ou ChatGPT, atteint chaque espace de travail dont son membre fait partie, dans toutes ses organisations. Une clé API n’atteint que son propre espace de travail, la liste contient donc une seule entrée. Choisissez un espace de travail en envoyant son id dans l’en-tête X-Workspace-Id sur toute autre requête.

Erreurs

  • 401 Unauthorized: Bearer token manquant ou non valide, ou code: "token_issuer_lost_access" quand la personne qui a créé la clé API a été désactivée ou a quitté l'espace de travail.
  • 403 Forbidden: code: "subscription_required" quand l'abonnement de l'espace de travail n'inclut pas l'accès à l'API, code: "workspace_access_denied" quand X-Workspace-Id désigne un espace de travail que ces identifiants ne peuvent pas atteindre, ou code: "permission_denied" quand votre rôle dans l'espace de travail n'a pas la permission redreplier.write (Admin et Editor l'ont).
  • 429 Too Many Requests: Limite de débit dépassée. Attendez le nombre de secondes indiqué dans Retry-After.
  • 500 Internal Server Error: Erreur serveur inattendue.
Exemple de requête (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
    }
  ]
}