Procurement | Approval Flows

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

nameFilterstringOptional

Responses

200

OK

application/json

Data transfer for an approval flow. Maps also to the [flow] entity of the appmixer service.

flowIdstring · nullableOptional

templateIdstring · uuidOptional

typestring · enumOptional

The type of approval flow. Simple approval flows are predefined flows which can be used out of the box. Custom approval flows are flows which can be customized by the user. Default approval flows are the default flows that are used when no other flow is specified.

Possible values:

stagestring · enumOptional

Indicates the stage of the approval flow. This represents the state of the flow in appmixer.

Possible values:

titlestring · nullableOptional

startedstring · date-timeOptional

createdstring · date-timeOptional

modifiedstring · date-timeOptional

descriptionstring · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/procurement/approval-flow-templates

HTTPcURLJavaScriptPython

GET /v1/procurement/approval-flow-templates HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "flowId": "text",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "Default",
  "stage": "Stopped",
  "title": "text",
  "started": "2026-07-15T16:46:43.890Z",
  "created": "2026-07-15T16:46:43.890Z",
  "modified": "2026-07-15T16:46:43.890Z",
  "description": "text"
}

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

flowTypeFilterstring · enumOptionalPossible values:

nameFilterstringOptional

Responses

200

OK

application/json

Resource list of configured approval flows for the tenant.

totalinteger · int32Optional

Total number of configured approval flows.

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/procurement/approval-flows

HTTPcURLJavaScriptPython

GET /v1/procurement/approval-flows HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "total": 1,
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "self": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "id": 1,
      "templateKey": "text",
      "name": "text",
      "requireSameLevelApproval": true,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ]
}

post

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

flowIdstring · nullableOptional

namestring · nullableOptional

descriptionstring · nullableOptional

templateIdstring · nullableOptional

requireSameLevelApprovalbooleanOptional

When true, an approval request is created for the other same-level approvers even if the order creator is themselves one of the approvers. When false (default), the order is auto-approved with no request in that case.

Responses

200

OK

application/json

Data transfer for an approval flow. Maps also to the [flow] entity of the appmixer service.

flowIdstring · nullableOptional

templateIdstring · uuidOptional

typestring · enumOptional

The type of approval flow. Simple approval flows are predefined flows which can be used out of the box. Custom approval flows are flows which can be customized by the user. Default approval flows are the default flows that are used when no other flow is specified.

Possible values:

stagestring · enumOptional

Indicates the stage of the approval flow. This represents the state of the flow in appmixer.

Possible values:

titlestring · nullableOptional

startedstring · date-timeOptional

createdstring · date-timeOptional

modifiedstring · date-timeOptional

descriptionstring · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/procurement/approval-flows

HTTPcURLJavaScriptPython

POST /v1/procurement/approval-flows HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 104

{
  "flowId": "text",
  "name": "text",
  "description": "text",
  "templateId": "text",
  "requireSameLevelApproval": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "flowId": "text",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "Default",
  "stage": "Stopped",
  "title": "text",
  "started": "2026-07-15T16:46:43.890Z",
  "created": "2026-07-15T16:46:43.890Z",
  "modified": "2026-07-15T16:46:43.890Z",
  "description": "text"
}

delete

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Responses

204

No Content

No content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

delete/v1/procurement/approval-flows

HTTPcURLJavaScriptPython

DELETE /v1/procurement/approval-flows HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content