Referencia de APIGET

Listar workspaces

Lista los workspaces en los que puede actuar una credencial de RedReplier, con el rol y los permisos de cada uno.

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

Lista los workspaces en los que puede actuar una credencial de RedReplier, con el rol y los permisos de cada uno.

Token Bearer (token de API de RedReplier)

Autenticación

Envía un token de API de RedReplier o un token de acceso OAuth como Bearer token. Este endpoint está abierto a cualquier clave válida.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parámetros

Este endpoint no recibe parámetros de ruta ni de consulta.

Cuerpo de la solicitud

Este endpoint no requiere un cuerpo JSON.

Respuesta

Devuelve un objeto con un array workspaces.

  • workspaces (Workspace[]): Workspaces en los que puede actuar esta credencial.

Objeto Workspace

  • id (string): ID del workspace. Envíalo en la cabecera X-Workspace-Id para actuar en este workspace.
  • name (string): Nombre del workspace.
  • organization ({ id, name }): Organización propietaria del workspace.
  • role ({ key, name }): Tu rol en este workspace. key es admin, editor, contributor o viewer.
  • permissions (string[]): Claves de permiso que tienes en este workspace, como redreplier.write.
  • isDefault (boolean): True para el workspace en el que cae una llamada cuando no envías la cabecera X-Workspace-Id.
  • current (boolean): True para el workspace en el que cayó esta llamada.

Solicitud de ejemplo

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

Notas

Un inicio de sesión OAuth, como el conector de Claude o ChatGPT, llega a todos los workspaces a los que pertenece su miembro, en todas sus organizaciones. Una clave API solo llega a su propio workspace, así que la lista tiene una entrada. Elige un workspace enviando su id en la cabecera X-Workspace-Id en cualquier otra solicitud.

Errores

  • 401 Unauthorized: Bearer token ausente o no válido.
  • 500 Internal Server Error: Error inesperado del servidor.
Solicitud de ejemplo (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
    }
  ]
}