Obter todos os Workflow Approvals

GET https://.account-name.krzlabs.io/api/v1/workflow-approvals

Realiza a leitura de todos os workflow approvals.


Request

paginação / link de referência
Entenda como aplicar paginação e ordenação na sua listagem
Entenda como aplicar filtros na sua listagem
Entenda como expandir entidades relacionadas nos documentos da listagem

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description Optional Searchable
filters Object Conjunto de filtros do workflow not required false
exclude_products Array(ObjectId) Lista de produtos a serem excluídos not required false
included_products Array(ObjectId) Lista de produtos a serem incluídos not required false
steps Array(Object) Etapas do workflow not required false
code string Código identificador do workflow required true
name string Nome do workflow required true
description string Descrição do workflow not required false
tags Array(string) Lista de tags associadas not required false
enabled boolean Indica se o workflow está habilitado required false
default boolean Indica se o workflow é o padrão not required false
Exemplo em JSON
{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
        "filters": {
            "status": "pending",
            "priority": "high"
        },
        "exclude_products": [
            "64f1b3d4e5d987654321caaa",
            "64f1b3d4e5d987654321cbbb"
        ],
        "included_products": [
            "64f1b3d4e5d987654321cccc",
            "64f1b3d4e5d987654321cddd"
        ],
        "steps": [
            {
                "step_id": "64f1c4e6e5d567890abcd111",
                "name": "Validação Fiscal",
                "order": 1,
                "approvers": ["user1", "user2"]
            },
            {
                "step_id": "64f1c4e6e5d567890abcd112",
                "name": "Validação Comercial",
                "order": 2,
                "approvers": ["user3"]
            }
        ],
        "code": "WF-001",
        "name": "Workflow de Aprovação de Produtos",
        "description": "Fluxo para validação e aprovação de produtos antes da publicação.",
        "tags": ["aprovação", "produtos", "workflow"],
        "enabled": true,
        "default": false
    }]
}

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved