Approval Workflows

Endpointhttps://api.kontorion.eu/v1

List approval workflow templates

GET

https://api.kontorion.eu/v1

/approval-workflows

Returns a paginated list of approval workflow templates for the organization. Uses the unified field.op=value filter grammar.

List approval workflow templates › query Parameters

limit

integer

Page size

cursor

string

Pagination cursor

entity_type

string

Filter by entity type (eq/ne/in)

trigger_action

string

Filter by trigger action (eq/in)

status

string

Filter by status (eq/ne/in)

is_active

boolean

Filter by is_active flag (eq/ne)

name

string

Filter by template name (eq/contains)

created_at

string

Filter by created_at (eq/gt/gte/lt/lte)

updated_at

string

Filter by updated_at (eq/gt/gte/lt/lte)

List approval workflow templates › Responses

Paginated list in data envelope

object[]

created_at

string

description

string

entity_type

string

id

string

is_active

boolean

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

organization_id

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

object[]

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

GET/approval-workflows

curl --request GET \
  --url https://api.kontorion.eu/v1/approval-workflows

shell

Example Responses

{
  "key": [
    {
      "created_at": "created_at",
      "description": "description",
      "entity_type": "entity_type",
      "id": "id",
      "is_active": true,
      "name": "name",
      "on_rejection": "REVERT",
      "on_timeout": "ESCALATE",
      "organization_id": "organization_id",
      "status": "PENDING",
      "steps": [
        {
          "approver_roles": [
            "string"
          ],
          "approver_user_ids": [
            "string"
          ],
          "min_approvals": 0,
          "name": "name",
          "notify_on_start": true,
          "step_number": 0,
          "timeout_hours": 0
        }
      ],
      "trigger_action": "CREATE",
      "updated_at": "updated_at"
    }
  ]
}

json

application/json

Create an approval workflow template

POST

https://api.kontorion.eu/v1

/approval-workflows

Creates a new approval workflow template for the organization

Create an approval workflow template › Request Body

description

string

entity_type

string

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

object[]

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

Create an approval workflow template › Responses

Wrapped in data envelope

created_at

string

description

string

entity_type

string

id

string

is_active

boolean

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

organization_id

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

object[]

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

POST/approval-workflows

curl --request POST \
  --url https://api.kontorion.eu/v1/approval-workflows \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description",
  "entity_type": "entity_type",
  "name": "name",
  "on_rejection": "REVERT",
  "on_timeout": "ESCALATE",
  "steps": [
    {
      "approver_roles": [
        "string"
      ],
      "approver_user_ids": [
        "string"
      ],
      "min_approvals": 0,
      "name": "name",
      "notify_on_start": true,
      "step_number": 0,
      "timeout_hours": 0
    }
  ],
  "trigger_action": "CREATE"
}
'

shell

Example Request Body

{
  "description": "description",
  "entity_type": "entity_type",
  "name": "name",
  "on_rejection": "REVERT",
  "on_timeout": "ESCALATE",
  "steps": [
    {
      "approver_roles": [
        "string"
      ],
      "approver_user_ids": [
        "string"
      ],
      "min_approvals": 0,
      "name": "name",
      "notify_on_start": true,
      "step_number": 0,
      "timeout_hours": 0
    }
  ],
  "trigger_action": "CREATE"
}

json

Example Responses

{
  "key": {
    "created_at": "created_at",
    "description": "description",
    "entity_type": "entity_type",
    "id": "id",
    "is_active": true,
    "name": "name",
    "on_rejection": "REVERT",
    "on_timeout": "ESCALATE",
    "organization_id": "organization_id",
    "status": "PENDING",
    "steps": [
      {
        "approver_roles": [
          "string"
        ],
        "approver_user_ids": [
          "string"
        ],
        "min_approvals": 0,
        "name": "name",
        "notify_on_start": true,
        "step_number": 0,
        "timeout_hours": 0
      }
    ],
    "trigger_action": "CREATE",
    "updated_at": "updated_at"
  }
}

json

application/json

Get an approval workflow template

GET

https://api.kontorion.eu/v1

/approval-workflows/{id}

Returns a single approval workflow template by ID

Get an approval workflow template › path Parameters

id

string · required

Workflow template UUID

Get an approval workflow template › Responses

Wrapped in data envelope

created_at

string

description

string

entity_type

string

id

string

is_active

boolean

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

organization_id

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

object[]

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

GET/approval-workflows/{id}

curl --request GET \
  --url https://api.kontorion.eu/v1/approval-workflows/:id

shell

Example Responses

{
  "key": {
    "created_at": "created_at",
    "description": "description",
    "entity_type": "entity_type",
    "id": "id",
    "is_active": true,
    "name": "name",
    "on_rejection": "REVERT",
    "on_timeout": "ESCALATE",
    "organization_id": "organization_id",
    "status": "PENDING",
    "steps": [
      {
        "approver_roles": [
          "string"
        ],
        "approver_user_ids": [
          "string"
        ],
        "min_approvals": 0,
        "name": "name",
        "notify_on_start": true,
        "step_number": 0,
        "timeout_hours": 0
      }
    ],
    "trigger_action": "CREATE",
    "updated_at": "updated_at"
  }
}

json

application/json

Update an approval workflow template

PUT

https://api.kontorion.eu/v1

/approval-workflows/{id}

Updates an existing approval workflow template by ID

Update an approval workflow template › path Parameters

id

string · required

Workflow template UUID

Update an approval workflow template › Request Body

description

string

is_active

boolean

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

object[]

Update an approval workflow template › Responses

Wrapped in data envelope

created_at

string

description

string

entity_type

string

id

string

is_active

boolean

name

string

on_rejection

string · enum

Enum values:

REVERT

HOLD

on_timeout

string · enum

Enum values:

ESCALATE

AUTO_APPROVE

AUTO_REJECT

organization_id

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

object[]

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

PUT/approval-workflows/{id}

curl --request PUT \
  --url https://api.kontorion.eu/v1/approval-workflows/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description",
  "is_active": true,
  "name": "name",
  "on_rejection": "REVERT",
  "on_timeout": "ESCALATE",
  "steps": [
    {
      "approver_roles": [
        "string"
      ],
      "approver_user_ids": [
        "string"
      ],
      "min_approvals": 0,
      "name": "name",
      "notify_on_start": true,
      "step_number": 0,
      "timeout_hours": 0
    }
  ]
}
'

shell

Example Request Body

{
  "description": "description",
  "is_active": true,
  "name": "name",
  "on_rejection": "REVERT",
  "on_timeout": "ESCALATE",
  "steps": [
    {
      "approver_roles": [
        "string"
      ],
      "approver_user_ids": [
        "string"
      ],
      "min_approvals": 0,
      "name": "name",
      "notify_on_start": true,
      "step_number": 0,
      "timeout_hours": 0
    }
  ]
}

json

Example Responses

{
  "key": {
    "created_at": "created_at",
    "description": "description",
    "entity_type": "entity_type",
    "id": "id",
    "is_active": true,
    "name": "name",
    "on_rejection": "REVERT",
    "on_timeout": "ESCALATE",
    "organization_id": "organization_id",
    "status": "PENDING",
    "steps": [
      {
        "approver_roles": [
          "string"
        ],
        "approver_user_ids": [
          "string"
        ],
        "min_approvals": 0,
        "name": "name",
        "notify_on_start": true,
        "step_number": 0,
        "timeout_hours": 0
      }
    ],
    "trigger_action": "CREATE",
    "updated_at": "updated_at"
  }
}

json

application/json

Archive an approval workflow template

DELETE

https://api.kontorion.eu/v1

/approval-workflows/{id}

Soft-deletes an approval workflow template by ID

Archive an approval workflow template › path Parameters

id

string · required

Workflow template UUID

Archive an approval workflow template › Responses

No content

No data returned

List approval requests

GET

https://api.kontorion.eu/v1

/approvals

Returns a paginated list of approval requests for the organization. Uses the unified field.op=value filter grammar.

List approval requests › query Parameters

limit

integer

Page size

cursor

string

Pagination cursor

status

string

Filter by status (eq/ne/in)

entity_type

string

Filter by entity type (eq/ne/in)

entity_id

string

Filter by entity id (eq/in)

workflow_template_id

string

Filter by workflow template id (eq/in)

trigger_action

string

Filter by trigger action (eq/in)

initiated_by

string

Filter by initiator (eq/in)

current_step

integer

Filter by current step (eq/gt/gte/lt/lte)

created_at

string

Filter by created_at (eq/gt/gte/lt/lte)

updated_at

string

Filter by updated_at (eq/gt/gte/lt/lte)

resolved_at

string

Filter by resolved_at (eq/gt/gte/lt/lte)

step_started_at

string

Filter by step_started_at (eq/gt/gte/lt/lte)

List approval requests › Responses

Paginated list in data envelope

object[]

created_at

string

current_step

integer

object[]

entity_id

string

entity_type

string

id

string

initiated_by

string

organization_id

string

payload

object

previous_state

object

resolved_at

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

step_started_at

string

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

workflow_template_id

string

GET/approvals

curl --request GET \
  --url https://api.kontorion.eu/v1/approvals

shell

Example Responses

{
  "key": [
    {
      "created_at": "created_at",
      "current_step": 0,
      "decisions": [
        {
          "approval_request_id": "approval_request_id",
          "comment": "comment",
          "decided_at": "decided_at",
          "decided_by": "decided_by",
          "decision": "APPROVED",
          "id": "id",
          "step_number": 0
        }
      ],
      "entity_id": "entity_id",
      "entity_type": "entity_type",
      "id": "id",
      "initiated_by": "initiated_by",
      "organization_id": "organization_id",
      "payload": {},
      "previous_state": {},
      "resolved_at": "resolved_at",
      "status": "PENDING",
      "step_started_at": "step_started_at",
      "trigger_action": "CREATE",
      "updated_at": "updated_at",
      "workflow_template_id": "workflow_template_id"
    }
  ]
}

json

application/json

Get an approval request

GET

https://api.kontorion.eu/v1

/approvals/{id}

Returns a single approval request by ID

Get an approval request › path Parameters

id

string · required

Approval request UUID

Get an approval request › Responses

Wrapped in data envelope

created_at

string

current_step

integer

object[]

entity_id

string

entity_type

string

id

string

initiated_by

string

organization_id

string

payload

object

previous_state

object

resolved_at

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

step_started_at

string

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

workflow_template_id

string

GET/approvals/{id}

curl --request GET \
  --url https://api.kontorion.eu/v1/approvals/:id

shell

Example Responses

{
  "key": {
    "created_at": "created_at",
    "current_step": 0,
    "decisions": [
      {
        "approval_request_id": "approval_request_id",
        "comment": "comment",
        "decided_at": "decided_at",
        "decided_by": "decided_by",
        "decision": "APPROVED",
        "id": "id",
        "step_number": 0
      }
    ],
    "entity_id": "entity_id",
    "entity_type": "entity_type",
    "id": "id",
    "initiated_by": "initiated_by",
    "organization_id": "organization_id",
    "payload": {},
    "previous_state": {},
    "resolved_at": "resolved_at",
    "status": "PENDING",
    "step_started_at": "step_started_at",
    "trigger_action": "CREATE",
    "updated_at": "updated_at",
    "workflow_template_id": "workflow_template_id"
  }
}

json

application/json

Approve an approval request

POST

https://api.kontorion.eu/v1

/approvals/{id}/approve

Approves a pending approval request, optionally with a comment

Approve an approval request › path Parameters

id

string · required

Approval request UUID

Approve an approval request › Request Body

comment

string

Approve an approval request › Responses

Wrapped in data envelope

created_at

string

current_step

integer

object[]

entity_id

string

entity_type

string

id

string

initiated_by

string

organization_id

string

payload

object

previous_state

object

resolved_at

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

step_started_at

string

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

workflow_template_id

string

POST/approvals/{id}/approve

curl --request POST \
  --url https://api.kontorion.eu/v1/approvals/:id/approve \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "comment"
}
'

shell

Example Request Body

{
  "comment": "comment"
}

json

Example Responses

{
  "key": {
    "created_at": "created_at",
    "current_step": 0,
    "decisions": [
      {
        "approval_request_id": "approval_request_id",
        "comment": "comment",
        "decided_at": "decided_at",
        "decided_by": "decided_by",
        "decision": "APPROVED",
        "id": "id",
        "step_number": 0
      }
    ],
    "entity_id": "entity_id",
    "entity_type": "entity_type",
    "id": "id",
    "initiated_by": "initiated_by",
    "organization_id": "organization_id",
    "payload": {},
    "previous_state": {},
    "resolved_at": "resolved_at",
    "status": "PENDING",
    "step_started_at": "step_started_at",
    "trigger_action": "CREATE",
    "updated_at": "updated_at",
    "workflow_template_id": "workflow_template_id"
  }
}

json

application/json

Cancel an approval request

POST

https://api.kontorion.eu/v1

/approvals/{id}/cancel

Cancels a pending approval request

Cancel an approval request › path Parameters

id

string · required

Approval request UUID

Cancel an approval request › Responses

No content

No data returned

Reject an approval request

POST

https://api.kontorion.eu/v1

/approvals/{id}/reject

Rejects a pending approval request, optionally with a comment

Reject an approval request › path Parameters

id

string · required

Approval request UUID

Reject an approval request › Request Body

comment

string

Reject an approval request › Responses

Wrapped in data envelope

created_at

string

current_step

integer

object[]

entity_id

string

entity_type

string

id

string

initiated_by

string

organization_id

string

payload

object

previous_state

object

resolved_at

string

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

TIMED_OUT

CANCELLED

step_started_at

string

trigger_action

string · enum

Enum values:

CREATE

UPDATE

PUBLISH

FINALIZE

RELEASE

ACTIVATE

DELETE

VOID

updated_at

string

workflow_template_id

string

POST/approvals/{id}/reject

curl --request POST \
  --url https://api.kontorion.eu/v1/approvals/:id/reject \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "comment"
}
'

shell

Example Request Body

{
  "comment": "comment"
}

json

Example Responses

{
  "key": {
    "created_at": "created_at",
    "current_step": 0,
    "decisions": [
      {
        "approval_request_id": "approval_request_id",
        "comment": "comment",
        "decided_at": "decided_at",
        "decided_by": "decided_by",
        "decision": "APPROVED",
        "id": "id",
        "step_number": 0
      }
    ],
    "entity_id": "entity_id",
    "entity_type": "entity_type",
    "id": "id",
    "initiated_by": "initiated_by",
    "organization_id": "organization_id",
    "payload": {},
    "previous_state": {},
    "resolved_at": "resolved_at",
    "status": "PENDING",
    "step_started_at": "step_started_at",
    "trigger_action": "CREATE",
    "updated_at": "updated_at",
    "workflow_template_id": "workflow_template_id"
  }
}

json

application/json

API Keys AuditEvents