Digitalk Developers
  1. Workspaces & Workflows
Raiz
  • Raiz
  • CRM
    • CRM — Overview
    • Genérico (data)
      • CRM - Genérico
      • Listar/filtrar registros (qualquer tabela do CRM)
      • Criar/atualizar registros (qualquer tabela do CRM)
      • Hard-delete (não permitido para tabelas company)
    • Empresas Relacionadas
      • CRM - Empresas relacionadas
      • Tipos de relacionamento disponíveis
      • Listar relacionamentos de uma empresa (ambas as direções)
      • Criar relacionamento entre duas empresas
      • Alterar o tipo do relacionamento
      • Inativar relacionamento (reversível)
      • Excluir relacionamento (hard-delete)
    • Ticket ↔ Empresa
      • CRM - Ticket <-> Empresa
      • Empresas elegíveis para o ticket
      • Vincular / trocar a empresa do ticket
    • Templates
      • CRM - Templates
      • Listar templates do tenant (apenas IDs, sem fields)
      • Detalhe completo do template (com fields)
      • Pesquisa formatada por scope (CRMSearchResult)
  • Workflow
    • Workflow - Overview
    • Tickets
      • Workflow - Tickets
      • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
      • Criar ticket (básico, com integração CRM opcional)
      • Criar ticket com auto-vínculo / criação de customer via contato
      • Movimentar ticket entre fases (ou finalizar)
      • Atualizar dados do ticket (nome, descrição)
      • Vincular cliente CRM a um ticket existente
      • Adicionar nota ou mensagem ao ticket
    • Workspaces & Workflows
      • Workflow - Workspaces & Workflows
      • Listar workspaces e workflows acessíveis ao usuário
        GET
      • Listar fases de um workflow
        GET
      • Listar tickets de uma ou mais fases (paginado)
        GET
  1. Workspaces & Workflows

Listar workspaces e workflows acessíveis ao usuário

GET
/api/v2/workspace/
Última modificação:2026-05-28 20:05:32
Retorna a estrutura completa de workspaces + workflows que o usuário da
api-key tem acesso. Use pra montar o seletor inicial (ex.: "qual workflow
vou abrir o ticket?").
Inclui também o array favorite[] — workflows marcados como favorito.

Hierarquia#

Workspace ─┬─ Workflow (com id, name, private, department)
           ├─ Workflow
           └─ ...

Requisição

Parâmetros Header

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v2/workspace/' \
--header 'api-key: {{api-key}}'

Respostas

🟢200OK
application/json
Estrutura com favorite[] + workspaces[].
Bodyapplication/json

Exemplo
{
    "favorite": [
        {
            "id": "70c273cc-144e-4587-9f23-a86054b8aed3",
            "id_workspace": "84b6cb66-f42f-41b6-bfac-d5f4c91453d7",
            "name": "Reclamações"
        }
    ],
    "workspaces": [
        {
            "id": "84b6cb66-f42f-41b6-bfac-d5f4c91453d7",
            "name": "Suporte ao cliente",
            "icon": "refresh-cw",
            "workflows": [
                {
                    "id": "70c273cc-144e-4587-9f23-a86054b8aed3",
                    "name": "Reclamações",
                    "private": false,
                    "department": 50
                },
                {
                    "id": "84b6cb66-f42f-41b6-bfac-d5f4c91453d7",
                    "name": "Dúvidas",
                    "private": false,
                    "department": 56
                }
            ]
        },
        {
            "id": "76c29a2c-a151-40bf-b1c8-bcd3e75dcad9",
            "name": "Financeiro",
            "icon": "settings",
            "workflows": [
                {
                    "id": "70c273cc-7e03-4fbc-b156-995884d7c283",
                    "name": "Análise",
                    "private": false,
                    "department": 104
                }
            ]
        }
    ]
}
🟠401Não Autorizado
Modificado em 2026-05-28 20:05:32
Página anterior
Workflow - Workspaces & Workflows
Próxima página
Listar fases de um workflow
Built with