---
title: "Workflows for the employer"
method: GET
path: "/v2/providers/employers/{employerId}/workflows"
tags: ["Workflows"]
---

# Workflows for the employer

`GET /v2/providers/employers/{employerId}/workflows`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/{employerId}/workflows`
- Auth: none required

__Activity name:__ <a href="https://developer.loket.nl/Activities/GetWorkflowsByEmployerId" target="_blank">GetWorkflowsByEmployerId</a><br>    <br><br>Get the list of all workflows for an employer. All as in both open as finished workflows are returned.<br>

## Path parameters

- `employerId` string, uuid, required

## Query parameters

- `filter` string
- `orderBy` string
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Authorization` string, required
- `Accept` string, required

## Response `200`

OK

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `totalSize` integer: Total number of records, taking into account the given filter.
  - `pageSize` integer: Number of records in the response
  - `totalPages` integer: Number of pages available
  - `currentPage` integer: Current page returned in the response
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `_embedded` Workflows[]
    - `id` string, uuid: The unique identifier of an object (GUID/UUID)
    - `status` object: Indicates the status of the workflow as a whole.
      - `key` integer: The unique identifier
      - `value` string
    - `functionalStatus` object: Indicates the status of the workflow as a whole.
      - `key` integer: The unique identifier
      - `value` string: The current functional status of the workflow. This further specifies the `status`
    - `canBeEditedByInitiator` boolean: Indicates if the initiator of the worflow is allowed to change the/some of the values of the initial request
    - `canBeCancelledByInitiator` boolean: Indicates if the initiator of the worflow is allowed to change the/some of the values of the initial request
    - `currentTask` object, nullable
      - `type` string: The type of the currently active task.
    - `assignees` object[]: A workflow is assigned to one or more roles.
      - `user` object, nullable
        - `id` string, uuid: The unique identifier of an object (GUID/UUID)
        - `initials` string
        - `prefix` string
        - `lastName` string
        - `formattedName` string
      - `role` object, nullable
        - `id` string, uuid: The unique identifier of an object (GUID/UUID)
        - `description` string: A description of the role.
      - `userResponsibility` object, nullable
        - `id` string, uuid: The unique identifier of an object (GUID/UUID)
        - `description` string: A description of the user responsibility
    - `trigger` object: Indicates the trigger that started the workflow. `trigger` is a metadata field within the employer context. Possible values can be managed by the user.
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `description` string
    - `workflowTemplate` object: Indicates what workflow template was used to initiate the workflow. `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user.
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `description` string
    - `allowedTransitions` object, nullable: In this object the possible transitions are returned. By sending a request to the `href` with the given `httpVerb` and one of the options given in `transitions` in the body. The workflow is transitioned to the given state.
      - `description` string, nullable: The description of the transition (task)
      - `href` string
      - `httpVerb` 'POST' | 'PATCH' | 'PUT', enum
      - `transitions` object[]
        - `action` string, uuid: The unique identifier for the action to be taken
        - `description` string: Description of the action
        - `data` object
    - `comment` object, nullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `userId` string, uuid: The unique identifier of an object (GUID/UUID)
      - `timestamp` string, date-time
      - `text` string: The text of the comment
    - `initiatedOn` string, date-time
    - `initiatedBy` UserBasicNotNullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `lastModifiedOn` string, date-time: date and time on which the last modification on the workflow was performed. This can be either by the system or a user.
    - `lastModifiedBy` UserBasicNotNullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `apiPayload` string: The json of the initiation payload
    - `apiParams` object: Key value map containing all the parameters used in the initiation request
    - `comments` object[]: In this object the possible comments are returned.
      - `commentedBy` UserBasicNotNullable
        - `id` string, uuid: The unique identifier of an object (GUID/UUID)
        - `initials` string: The initials of the user
        - `prefix` string, nullable: The prefix of the user
        - `lastName` string: The last name of the user
        - `formattedName` string: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
      - `commentedOn` string, date-time: The date and time on which the comment was made.
      - `comment` string: The text of the comment
    - `apiViewModel` object: The model provides the other processes with all the information they require. This is a snapshot of the moment of submitting/starting the workflow. due to the dynamic nature of this object the following filtering operators are not supported: gt, ge, lt and le

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)