Skip to main content
GET
/
v1
/
workflows
Listar workflows
curl --request GET \
  --url https://api.base39.io/v1/workflows \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "<any>",
      "name": "<string>",
      "status": "draft",
      "content": {
        "trigger": {
          "id": "<string>",
          "name": "<string>",
          "type": "webhook-base39",
          "parameters": {
            "enabled": true,
            "event": "loan.created"
          }
        },
        "actions": [
          {
            "id": "<string>",
            "name": "<string>",
            "type": "conditional",
            "parameters": {
              "conditions": [
                [
                  "<string>"
                ]
              ],
              "default": "<string>"
            }
          }
        ],
        "subflows": {}
      },
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "key_643969122d598f5b62d15fbc",
        "externalClientId": "optr_643969122d598f5b62d15fbd"
      },
      "updatedBy": {
        "clientId": "key_643969122d598f5b62d15fbc",
        "externalClientId": "optr_643969122d598f5b62d15fbd"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
limit
integer
default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

​
starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

Response

200 - application/json

Um objeto com uma propriedade data que contém um array de itens começando após o item starting_after. Cada entrada no array é um objeto Workflow separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de workflows. A parte de uma resposta da API que descreve a paginação

​
hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

​
data
Workflow · object[]

Uma lista de workflows

⌘I