---
title: "List of messages of a collective action"
method: GET
path: "/users/collectiveactions/{collectiveActionId}"
tags: ["Collective action"]
---

# List of messages of a collective action

`GET /users/collectiveactions/{collectiveActionId}`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/users/collectiveactions/{collectiveActionId}`
- Auth: none required
- TypeScript: <https://skmtc.dev/loket-acc/apis/loket-api/docs/users/collectiveactions/:collectiveActionId/get.ts> (a function with typed inputs; its response is checked against the schema)

__Activity name :__ <a href="https://developer.loket.nl/Activities/GetCollectiveActionMessagesByCollectiveActionId" target="_blank">GetCollectiveActionMessagesByCollectiveActionId</a>

Get the messages of all collectiveActionItems of a single collective action

## Path parameters

- `collectiveActionId` string, uuid, required

## 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` CollectiveActionDetail[]
    - `collectiveActionItemId` string, uuid: The unique identifier of an object (GUID/UUID)
    - `createdOn` string, date-time: Date-time when the collectiveActionItem was created.
    - `succes` boolean: status of the collectiveActionItem
    - `collectiveActionType` 'Werknemerloket' | 'Beloning' | 'etc.': the type of collectiveAction
    - `entityId` string, uuid: The unique identifier of the entity to which the item applies. If the collectiveActionType = 'Werknemerloket' then entityId contains an employeeId. In all other cases, the entityId contains an employmentId
    - `employerId` string, uuid, nullable: The unique identifier of an object (GUID/UUID)
    - `payrollAdministrationId` string, uuid, nullable: The unique identifier of an object (GUID/UUID)
    - `employmentId` string, uuid, nullable: The unique identifier of an object (GUID/UUID)
    - `messages` object[], nullable: array of messages of an collectiveactionitem.
      - `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

## Other responses

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

---

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