Fetch all workflows

GET

transform

workflows

curl --request GET \
  --url https://api.invopop.com/transform/v1/workflows

{
  "created_at": "<string>",
  "limit": 123,
  "list": [
    {
      "country": "<string>",
      "created_at": "<string>",
      "description": "<string>",
      "disabled": true,
      "draft": true,
      "hash": "<string>",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "rescue": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "status": "OK",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": [
                {}
              ],
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "schema": "<string>",
      "steps": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "status": "OK",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": [
                {}
              ],
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "updated_at": "<string>",
      "version": "<string>"
    }
  ],
  "next_created_at": "<string>",
  "schema": "bill/invoice"
}

Query Parameters

limit

integer

Maximum number of workflows to return.

Example:

100

created_at

string

Date from which results are provided.

Example:

"2023-08-02T00:00:00.000Z"

schema

string

Short schema name that the workflow will be allowed to process.

Example:

"bill/invoice"

Response

200 - application/json

created_at

string

First or queried timestamp when the first entry in the page was created.

limit

integer

Maximum number of objects returned in a page.

list

object[] | null

List of workflows.

list.country

string

ISO country code the workflow will be used for.

list.created_at

string

When the workflow was created.

list.description

string

Description of the workflow

list.disabled

boolean

When true, this workflow can no longer be used.

list.draft

boolean

When true, this workflow is still in draft mode and will not be used in jobs.

list.hash

string

Partial SHA256 hash of the workflow's contents.

list.id

string

The UUID (any version) of the workflow.

Example:

"186522a6-e697-4e34-8498-eee961bcb845"

list.name

string

Name of the workflow

list.rescue

object[] | null

List of steps to execute when a KO status is returned by a previous step and not explicitly managed.

list.schema

string

Short schema name that the workflow will be allowed to process.

list.steps

object[] | null

List of steps to execute.

list.updated_at

string

When the workflow was last updated.

list.version

string

Version of the workflow's contents currently defined.

next_created_at

string

Timestamp that indicates the start of the next page of results, if any.

schema

string

Short schema name that the workflows have been filtered by.

Example:

"bill/invoice"

Sign GOBL Document Create a workflow

curl --request GET \
  --url https://api.invopop.com/transform/v1/workflows

{
  "created_at": "<string>",
  "limit": 123,
  "list": [
    {
      "country": "<string>",
      "created_at": "<string>",
      "description": "<string>",
      "disabled": true,
      "draft": true,
      "hash": "<string>",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "rescue": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "status": "OK",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": [
                {}
              ],
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "schema": "<string>",
      "steps": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "status": "OK",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": [
                {}
              ],
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "updated_at": "<string>",
      "version": "<string>"
    }
  ],
  "next_created_at": "<string>",
  "schema": "bill/invoice"
}

Introduction

API

Guides

Fetch all workflows

Query Parameters

Response