Referência da APIGET

Listar workspaces

Lista os workspaces em que uma credencial do RedReplier pode agir, com o papel e as permissões em cada um.

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

Lista os workspaces em que uma credencial do RedReplier pode agir, com o papel e as permissões em cada um.

Token Bearer (token de API do RedReplier)

Autenticação

Envie um token de API do RedReplier ou um token de acesso OAuth como Bearer token. Este endpoint está aberto a qualquer chave válida.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parâmetros

Este endpoint não recebe parâmetros de caminho nem de consulta.

Corpo da requisição

Este endpoint não exige corpo JSON.

Resposta

Retorna um objeto com um array workspaces.

  • workspaces (Workspace[]): Workspaces em que esta credencial pode agir.

Objeto Workspace

  • id (string): ID do workspace. Envie-o no cabeçalho X-Workspace-Id para agir neste workspace.
  • name (string): Nome do workspace.
  • organization ({ id, name }): Organização dona do workspace.
  • role ({ key, name }): Seu papel neste workspace. key é admin, editor, contributor ou viewer.
  • permissions (string[]): Chaves de permissão que você tem neste workspace, como redreplier.write.
  • isDefault (boolean): True para o workspace em que uma chamada cai quando você não envia o cabeçalho X-Workspace-Id.
  • current (boolean): True para o workspace em que esta chamada caiu.

Exemplo de requisição

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

Notas

Um login OAuth, como o conector do Claude ou do ChatGPT, alcança todos os workspaces de que o membro faz parte, em todas as organizações. Uma chave API alcança apenas o próprio workspace, então a lista tem uma entrada. Escolha um workspace enviando o id dele no cabeçalho X-Workspace-Id em qualquer outra requisição.

Erros

  • 401 Unauthorized: Bearer token ausente ou inválido.
  • 500 Internal Server Error: Erro inesperado do servidor.
Exemplo de solicitação (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
    }
  ]
}