Listar workspaces

api-referenceGET

GEThttps://analytics.flowsery.com/analytics/api/v1/workspaces

Lista os workspaces em que esta credencial pode agir. Envie um id retornado no cabeçalho X-Workspace-Id para executar qualquer outra requisição nesse workspace.

Token Bearer (token API de workspace ou login OAuth)

Quem vê quais workspaces

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. Um token API de workspace <code>flow_ws_</code> alcança apenas o próprio workspace, então a lista tem uma entrada. <code>current</code> marca o workspace em que esta chamada caiu. Só são listados os workspaces em que você tem <code>flowsery.write</code>, ou seja, os papéis Admin e Editor.

Chaves de website recebem 400

Uma chave API de website <code>flow_</code> é limitada a um website e não tem um membro por trás, então este endpoint responde <code>400 Bad Request</code>. Use um token API de workspace ou um login OAuth.

Campos de resposta

Parametro	Tipo	Descricao
`id`	`string`	ID do workspace. Envie-o no cabeçalho X-Workspace-Id para agir neste workspace.
`name`	`string`	Nome do workspace.
`organization.id`	`string`	ID da organização dona do workspace.
`organization.name`	`string`	Nome da organização dona do workspace.
`role.key`	`string`	Seu papel neste workspace: admin ou editor, os papéis que podem usar o Flowsery.
`role.name`	`string`	Nome de exibição do papel.
`permissions`	`string[]`	Chaves de permissão que você tem neste workspace, como flowsery.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.

Solicitação de exemplo (curl)

curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/workspaces \
  --header 'Authorization: Bearer <workspace-api-token>'

200

{
  "status": "success",
  "data": [
    {
      "id": "cm8ws1a2b3",
      "name": "Acme marketing",
      "organization": { "id": "org_01J8ZK4M2Q", "name": "Acme" },
      "role": { "key": "editor", "name": "Editor" },
      "permissions": [
        "workspace.read",
        "posts.read",
        "accounts.read",
        "posts.draft",
        "media.upload",
        "analytics.read",
        "ai.generate",
        "members.read",
        "tokens.own",
        "posts.others",
        "posts.schedule",
        "posts.publish",
        "posts.delete",
        "analytics.sync",
        "webhooks.read",
        "webhooks.manage",
        "signature.manage",
        "flowsery.write",
        "redreplier.write",
        "claw.use"
      ],
      "isDefault": true,
      "current": true
    },
    {
      "id": "cm8ws4c5d6",
      "name": "Northwind",
      "organization": { "id": "org_01J9P7T3XB", "name": "Northwind Studio" },
      "role": { "key": "admin", "name": "Admin" },
      "permissions": [
        "workspace.read",
        "workspace.manage",
        "posts.read",
        "posts.draft",
        "posts.others",
        "posts.schedule",
        "posts.publish",
        "posts.delete",
        "media.upload",
        "accounts.read",
        "accounts.manage",
        "analytics.read",
        "analytics.sync",
        "ai.generate",
        "members.read",
        "members.manage",
        "tokens.own",
        "tokens.manage",
        "webhooks.read",
        "webhooks.manage",
        "signature.manage",
        "flowsery.write",
        "redreplier.write",
        "claw.use"
      ],
      "isDefault": false,
      "current": false
    }
  ]
}