GET
/
v1
/
flows
Recuperar todos os fluxos paginado
curl --request GET \
  --url https://api.malga.io/v1/flows \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "identificador único do fluxo"
              },
              "paymentMethod": {
                "type": "string",
                "description": "método de pagamento a qual aquele fluxo é relacionado"
              },
              "clientId": {
                "type": "string",
                "description": "identificador do cliente dono do fluxo"
              },
              "merchants": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "description": "identificador do merchant relacionado ao fluxo"
                    }
                  }
                }
              },
              "parentId": {
                "type": "string",
                "description": "identificador do fluxo que originou o novo"
              },
              "restoredFrom": {
                "type": "string",
                "description": "identificador do fluxo do qual este foi restaurado"
              },
              "createdAt": {
                "type": "string",
                "description": "data e hora em que o fluxo foi criado (UTC)"
              },
              "flow": {
                "type": "object",
                "description": "dados do fluxo que será cadastrado"
              }
            },
            "example": {
              "id": "b4ced0dd-2136-4bce-a231-364e93554073",
              "merchants": [
                {
                  "merchantId": "z1babb21-6a4c-987d-89db-11d3af737ee1"
                }
              ],
              "paymentMethod": "credit",
              "clientId": "f1babb21-6a4c-323d-12db-69d3af407ee1",
              "parentId": "g1babb21-6a4c-987d-89db-11d3af737ee1",
              "createdAt": "2023-03-22T20:45:06.020Z",
              "flow": {
                "version": "0.0.0",
                "root": [
                  {
                    "rule": "provider",
                    "id": "z1babb21-6a4c-987d-89db-11d3af737ee1"
                  }
                ]
              },
              "restoredFrom": "df601922-e024-6394-8f12-af21ec4218b1"
            }
          }
        ]
      }
    },
    "meta": {
      "allOf": [
        {
          "properties": {
            "itemCount": {
              "type": "integer",
              "description": "quantidade de itens na página"
            },
            "totalItems": {
              "type": "integer",
              "description": "quantidade total de itens na consulta (esse valor é mantido em cache por 5 minutos para melhorar a performance da API)"
            },
            "itemsPerPage": {
              "type": "integer",
              "description": "quantidade de itens por página"
            },
            "totalPages": {
              "type": "integer",
              "description": "quantidade total de páginas"
            },
            "currentPage": {
              "type": "integer",
              "description": "página atual"
            }
          }
        }
      ]
    }
  },
  "example": {
    "items": [
      {
        "id": "b4ced0dd-2136-4bce-a231-364e93554073",
        "paymentMethod": "credit",
        "clientId": "f1babb21-6a4c-323d-12db-69d3af407ee1",
        "merchants": [
          {
            "merchantId": "z1babb21-6a4c-987d-89db-11d3af737ee1"
          }
        ],
        "parentId": "g1babb21-6a4c-987d-89db-11d3af737ee1",
        "createdAt": "2023-03-22T20:45:06.020Z",
        "flow": {
          "version": "0.0.0",
          "root": [
            {
              "rule": "provider",
              "id": "z1babb21-6a4c-987d-89db-11d3af737ee1"
            }
          ]
        },
        "restoredFrom": "df601922-e024-6394-8f12-af21ec4218b1"
      }
    ],
    "meta": {
      "itemCount": 10,
      "totalItems": 20,
      "itemsPerPage": 10,
      "totalPages": 5,
      "currentPage": 2
    }
  }
}

Authorizations

​
X-Client-Id
string
header
required
​
X-Api-Key
string
header
required

Query Parameters

​
page
number

número da página

​
limit
number

quantidade de itens por página

​
merchantId
string

usado para filtrar os fluxos por merchantId

​
paymentMethod
string

usado para filtrar os fluxos por método de pagamento

Response

200
application/json

Response de flow

The response is of type object.