---
updatedAt: 2026-05-01T08:14:29.000Z
agentTools:
  projectIndex: https://docs.company.info/llms.txt
---

# Get change updates for all items in a list

Get change updates for all items in a list


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NL Monitoring",
    "description": "NL Monitoring API represents the Monitoring of Changes in the Profile of the organizations and branches\n",
    "version": "v0.1.0"
  },
  "servers": [
    {
      "url": "https://api.company.info/nl/organizations/monitoring",
      "description": "Production Server"
    }
  ],
  "security": [
    {
      "authToken": []
    },
    {
      "jwtAuth": []
    }
  ],
  "paths": {
    "/v1/lists/{list_id}/updates": {
      "get": {
        "operationId": "getListUpdates",
        "summary": "Get change updates for all items in a list",
        "tags": [
          "List"
        ],
        "description": "Get change updates for all items in a list\n",
        "parameters": [
          {
            "name": "list_id",
            "in": "path",
            "required": true,
            "description": "The ID of the List that will be returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter",
            "in": "query",
            "style": "deepObject",
            "required": false,
            "description": "filter the updates",
            "explode": true,
            "schema": {
              "$ref": "#/components/schemas/Filter"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "style": "deepObject",
            "description": "`size` defines the number of records to return in each page.\ndefault value: 10, maximum value: 20.\n<br>`number` specifies the page number.\"\n",
            "schema": {
              "$ref": "#/components/schemas/Page"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Correlation-Id": {
                "description": "Unique request identifier",
                "schema": {
                  "type": "string",
                  "format": "uuid"
                }
              }
            },
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdatesResults"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "authToken": {
        "description": "API Key Authentication",
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      },
      "jwtAuth": {
        "description": "JWT Authentication",
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "Filter": {
        "title": "UpdateEventsFilters",
        "type": "object",
        "description": "the list of filters to retrieve update events",
        "properties": {
          "eventType": {
            "type": "string",
            "enum": [
              "change"
            ],
            "example": "change"
          },
          "entity": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "example": "34251678"
              }
            }
          },
          "date": {
            "type": "object",
            "properties": {
              "from": {
                "type": "string",
                "example": "2024-03-01T00:00:00+01:00"
              },
              "to": {
                "type": "string",
                "example": "2024-03-03T00:00:00+01:00"
              }
            }
          },
          "collections": {
            "type": "string",
            "description": "Comma-separated collection names",
            "example": "activities,name"
          }
        }
      },
      "UpdatesResults": {
        "title": "UpdateEventsResult",
        "description": "list of update events",
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "type",
                "id",
                "attributes"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "example": "01HQ8DJJAZW067WSTRM6M7EWB2"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "updates"
                  ],
                  "example": "updates"
                },
                "attributes": {
                  "type": "object",
                  "required": [
                    "entity",
                    "eventType",
                    "collection",
                    "publishedAt"
                  ],
                  "properties": {
                    "entity": {
                      "type": "object",
                      "required": [
                        "id",
                        "type"
                      ],
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "33302047"
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "organization",
                            "branch"
                          ],
                          "example": "organization"
                        }
                      }
                    },
                    "eventType": {
                      "type": "string",
                      "enum": [
                        "change"
                      ],
                      "example": "change"
                    },
                    "collection": {
                      "type": "string",
                      "description": "The single collection that changed for this update event. See CollectionEnum for the list of possible values.",
                      "example": "activities"
                    },
                    "publishedAt": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2024-05-15T13:25:43+02:00"
                    }
                  }
                },
                "relationships": {
                  "type": "object",
                  "properties": {
                    "organization": {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "object",
                          "required": [
                            "type",
                            "id"
                          ],
                          "properties": {
                            "type": {
                              "type": "string",
                              "example": "organizations"
                            },
                            "id": {
                              "type": "string",
                              "example": "33302047"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "included": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "example": "organizations"
                },
                "id": {
                  "type": "string",
                  "example": "33302047"
                },
                "attributes": {
                  "type": "object",
                  "properties": {
                    "identifiers": {
                      "type": "object",
                      "properties": {
                        "tradeRegister": {
                          "type": "object",
                          "properties": {
                            "system": {
                              "type": "string",
                              "example": "tradeRegister"
                            },
                            "value": {
                              "type": "string",
                              "example": "33302047"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "links": {
                  "type": "object",
                  "properties": {
                    "self": {
                      "type": "string",
                      "format": "uri-reference"
                    }
                  }
                }
              }
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "first": {
                "type": "string",
                "format": "uri-reference"
              },
              "last": {
                "type": "string",
                "format": "uri-reference"
              },
              "next": {
                "type": "string",
                "format": "uri-reference"
              },
              "prev": {
                "type": "string",
                "format": "uri-reference"
              },
              "self": {
                "type": "string",
                "format": "uri-reference"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "totalResults": {
                "type": "integer"
              },
              "totalPages": {
                "type": "integer"
              }
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "errors"
        ],
        "properties": {
          "errors": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "object",
              "required": [
                "status",
                "code",
                "title",
                "detail"
              ],
              "properties": {
                "status": {
                  "description": "the HTTP status code applicable to this problem",
                  "type": "string",
                  "example": "400"
                },
                "code": {
                  "description": "an application-specific error code",
                  "type": "string",
                  "example": "400"
                },
                "title": {
                  "description": "a short, human-readable summary of the problem",
                  "type": "string",
                  "example": "failed on Bad Request"
                },
                "detail": {
                  "description": "a human-readable explanation specific to this occurrence of the problem",
                  "type": "string",
                  "example": "list not found"
                }
              }
            }
          }
        }
      },
      "Page": {
        "type": "object",
        "properties": {
          "size": {
            "type": "integer",
            "default": 10,
            "description": "The number of records to return in each page."
          },
          "number": {
            "type": "integer",
            "default": 1,
            "description": "This parameter specifies the page number."
          }
        }
      }
    }
  },
  "x-readme": {
    "proxy-enabled": false
  }
}
```