---
updatedAt: 2026-05-04T09:40:06.000Z
agentTools:
  projectIndex: https://docs.company.info/llms.txt
---

# List previously placed orders

List previously placed orders


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NL Official Documents API",
    "description": "NL Official Documents API project represents the functionality to order documents from the KVK website.\n",
    "version": "v0.1.0"
  },
  "servers": [
    {
      "url": "https://api.company.info/nl/organizations/official-documents",
      "description": "Production Server"
    }
  ],
  "security": [
    {
      "authToken": []
    },
    {
      "jwtAuth": []
    }
  ],
  "paths": {
    "/v1/orders": {
      "get": {
        "operationId": "getOrdersList",
        "summary": "List previously placed orders",
        "tags": [
          "Order"
        ],
        "description": "List previously placed orders\n",
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "style": "deepObject",
            "description": "Filter is used for filtering the orders based on `documentType`, `organizationID`, and `branchID`.",
            "schema": {
              "type": "object",
              "description": "Filter is used for filtering the orders based on `documentType`, `organizationID`, `branchID`, `status`, and `date`.",
              "properties": {
                "organizationID": {
                  "type": "string",
                  "example": "11111111"
                },
                "branchID": {
                  "type": "string",
                  "example": "111111110011"
                },
                "status": {
                  "type": "string",
                  "example": "done"
                },
                "documentType": {
                  "type": "string",
                  "enum": [
                    "standardExtract"
                  ],
                  "example": "standardExtract"
                },
                "date": {
                  "type": "object",
                  "properties": {
                    "from": {
                      "type": "string",
                      "example": "2024-08-06"
                    },
                    "to": {
                      "type": "string",
                      "example": "2024-08-07"
                    }
                  }
                }
              }
            }
          },
          {
            "name": "page",
            "in": "query",
            "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": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/OrderResultData"
                      }
                    },
                    "links": {
                      "$ref": "#/components/schemas/PaginationLinks"
                    },
                    "meta": {
                      "$ref": "#/components/schemas/PaginationMeta"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  },
  "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": {
      "OrderResultData": {
        "title": "Order",
        "type": "object",
        "required": [
          "id",
          "type",
          "attributes"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "01HS0SZQECSKQ8NV20391MZ0R1"
          },
          "type": {
            "type": "string",
            "enum": [
              "orders"
            ],
            "example": "orders"
          },
          "attributes": {
            "type": "object",
            "required": [
              "documentType",
              "organizationID",
              "status",
              "createdAt"
            ],
            "properties": {
              "documentType": {
                "type": "string",
                "enum": [
                  "standardExtract"
                ],
                "example": "standardExtract"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "done",
                  "failed",
                  "cancelled"
                ],
                "example": "pending"
              },
              "organizationID": {
                "type": "string",
                "example": "33302047"
              },
              "branchID": {
                "type": "string",
                "description": "Present when the order was placed for a specific branch.",
                "example": "000016450760"
              },
              "productName": {
                "type": "string",
                "enum": [
                  "directRelations",
                  "totalConcern",
                  "deedOfIncorporation",
                  "actOfIncorporation",
                  "amendmentOfArticlesOfAssociation",
                  "deedOfMerger",
                  "rectification",
                  "deedOfDivision",
                  "mostRecentArticlesOfAssociation",
                  "mergerDemergerProposal",
                  "demergerDeed",
                  "latestArticlesOfAssociation",
                  "articlesOfIncorporation",
                  "articlesOfAssociation"
                ],
                "description": "Present for statute and concernRelations orders.",
                "example": "directRelationships"
              },
              "productDate": {
                "type": "string",
                "description": "Present for `standardStatute`, `maskedStatute` and `annualAccounts` orders. Can be a full date or a year.",
                "oneOf": [
                  {
                    "type": "string",
                    "format": "date",
                    "example": "2023-12-06"
                  },
                  {
                    "type": "string",
                    "pattern": "^\\d{4}$",
                    "example": "2023"
                  }
                ]
              },
              "mimeTypes": {
                "type": "array",
                "description": "Available mime types for downloading this order's document. May\nbe absent when the order is still `pending` or has `failed`.\n",
                "items": {
                  "type": "string",
                  "enum": [
                    "application/pdf",
                    "application/json",
                    "application/zip",
                    "text/html"
                  ]
                },
                "example": [
                  "text/html",
                  "application/pdf",
                  "application/json",
                  "application/zip"
                ]
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "example": "2024-03-15T11:19:39+01:00"
              }
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string",
                "format": "uri-reference"
              }
            }
          }
        }
      },
      "PaginationLinks": {
        "title": "PaginationLinks",
        "description": "JSON:API pagination `links`. The service emits bare string URIs (not\nthe `oneOf(string, object)` shape of the shared JSONAPI schema), so\nstrict client generators must model these as plain `string`.\n",
        "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"
          }
        }
      },
      "PaginationMeta": {
        "title": "PaginationMeta",
        "type": "object",
        "properties": {
          "totalPages": {
            "type": "integer",
            "example": 15
          },
          "totalResults": {
            "type": "integer",
            "example": 150
          }
        }
      },
      "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."
          }
        }
      },
      "JSONAPIErrorResponse": {
        "title": "JSON:API Error Response",
        "type": "object",
        "required": [
          "errors"
        ],
        "properties": {
          "errors": {
            "title": "An array of Error objects",
            "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",
                  "minLength": 3,
                  "maxLength": 3
                },
                "code": {
                  "description": "an application-specific error code. It can be the same as 'status'",
                  "type": "string"
                },
                "title": {
                  "description": "a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization",
                  "type": "string"
                },
                "detail": {
                  "description": "a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/vnd.api+json": {
            "schema": {
              "$ref": "#/components/schemas/JSONAPIErrorResponse"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/vnd.api+json": {
            "schema": {
              "$ref": "#/components/schemas/JSONAPIErrorResponse"
            }
          }
        }
      }
    }
  }
}
```