order_forms

List all order forms

Changed on

This endpoint is used to list all existing order forms. This is a premium feature.

get/order_forms

Request

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

status[]string[]

Filter order forms by status. Possible values are generated, signed, expired and voided.

customer_id[]string[]

Filter order forms by the Lago identifiers of their customers.

[
  "1a901a90-1a90-1a90-1a90-1a901a901a90"
]
number[]string[]

Filter order forms by their number, as assigned by Lago.

[
  "OF-2026-0001",
  "OF-2026-0002"
]
quote_number[]string[]

Filter order forms by the number of the quote they come from.

[
  "QT-2026-0001"
]
owner_id[]string[]

Filter order forms by the Lago identifiers of the users owning the quote they come from.

[
  "1a901a90-1a90-1a90-1a90-1a901a901a90"
]
search_termstring
Example:OF-2026

Search order forms by number.

created_at_fromstring date-time
Example:2026-01-01T00:00:00Z

Filter order forms created from a specific date and time, in UTC (ISO 8601).

created_at_tostring date-time
Example:2026-12-31T23:59:59Z

Filter order forms created up to a specific date and time, in UTC (ISO 8601).

expires_at_fromstring date-time
Example:2026-01-01T00:00:00Z

Filter order forms expiring from a specific date and time, in UTC (ISO 8601). Order forms that never expire are excluded.

expires_at_tostring date-time
Example:2026-12-31T23:59:59Z

Filter order forms expiring up to a specific date and time, in UTC (ISO 8601). Order forms that never expire are excluded.

Response

Order forms

Example response

{
  "order_forms": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "number": "OF-2026-0001",
      "status": "generated",
      "void_reason": "manual",
      "expires_at": "2026-06-30T23:59:59Z",
      "signed_at": "2026-04-29T08:59:51Z",
      "voided_at": "2026-04-29T08:59:51Z",
      "signed_document_url": "https://api.getlago.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMi/OF-2026-0001",
      "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_quote_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_quote_version_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2026-04-29T08:59:51Z",
      "updated_at": "2026-04-29T08:59:51Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

Changes