List all order forms

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/order_forms?per_page=20&page=1&status[]=generated" \
  --header "Authorization: Bearer $API_KEY"

from lago_python_client.client import Client
from lago_python_client.exceptions import LagoApiError

client = Client(api_key='__YOUR_API_KEY__')

try:
    client.order_forms.find_all({'per_page': 20, 'page': 1, 'status[]': ['generated']})
except LagoApiError as e:
    repair_broken_state(e)  # do something on error or raise your own exception

require 'lago-ruby-client'

client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__')

client.order_forms.get_all({ per_page: 20, page: 1, 'status[]': ['generated'] })

await client.orderForms.findAllOrderForms({ per_page: 20, page: 1, "status[]": ["generated"] });

import (
	"context"
	"fmt"

	lago "github.com/getlago/lago-go-client"
)

func main() {
	lagoClient := lago.New().SetApiKey("__YOUR_API_KEY__")
	ctx := context.Background()

	page, perPage := 1, 20
	orderFormResult, err := lagoClient.OrderForm().GetList(ctx, &lago.OrderFormListInput{
		Page:    &page,
		PerPage: &perPage,
		Status:  []lago.OrderFormStatus{lago.OrderFormStatusGenerated},
	})
	if err != nil {
		// Error is *lago.Error
		panic(err)
	}

	// orderFormResult is *lago.OrderFormResult
	fmt.Println(orderFormResult)
}

{
  "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,
    "total_pages": 4,
    "total_count": 70,
    "next_page": 3,
    "prev_page": 1
  }
}

{
  "status": 401,
  "error": "Unauthorized"
}

{
  "status": 403,
  "error": "Forbidden",
  "code": "feature_unavailable"
}

{
  "status": 422,
  "error": "Unprocessable entity",
  "code": "validation_errors",
  "error_details": {}
}

GET

order_forms

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/order_forms?per_page=20&page=1&status[]=generated" \
  --header "Authorization: Bearer $API_KEY"

from lago_python_client.client import Client
from lago_python_client.exceptions import LagoApiError

client = Client(api_key='__YOUR_API_KEY__')

try:
    client.order_forms.find_all({'per_page': 20, 'page': 1, 'status[]': ['generated']})
except LagoApiError as e:
    repair_broken_state(e)  # do something on error or raise your own exception

require 'lago-ruby-client'

client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__')

client.order_forms.get_all({ per_page: 20, page: 1, 'status[]': ['generated'] })

await client.orderForms.findAllOrderForms({ per_page: 20, page: 1, "status[]": ["generated"] });

import (
	"context"
	"fmt"

	lago "github.com/getlago/lago-go-client"
)

func main() {
	lagoClient := lago.New().SetApiKey("__YOUR_API_KEY__")
	ctx := context.Background()

	page, perPage := 1, 20
	orderFormResult, err := lagoClient.OrderForm().GetList(ctx, &lago.OrderFormListInput{
		Page:    &page,
		PerPage: &perPage,
		Status:  []lago.OrderFormStatus{lago.OrderFormStatusGenerated},
	})
	if err != nil {
		// Error is *lago.Error
		panic(err)
	}

	// orderFormResult is *lago.OrderFormResult
	fmt.Println(orderFormResult)
}

{
  "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,
    "total_pages": 4,
    "total_count": 70,
    "next_page": 3,
    "prev_page": 1
  }
}

{
  "status": 401,
  "error": "Unauthorized"
}

{
  "status": 403,
  "error": "Forbidden",
  "code": "feature_unavailable"
}

{
  "status": 422,
  "error": "Unprocessable entity",
  "code": "validation_errors",
  "error_details": {}
}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/order_forms?per_page=20&page=1&status[]=generated" \
  --header "Authorization: Bearer $API_KEY"

from lago_python_client.client import Client
from lago_python_client.exceptions import LagoApiError

client = Client(api_key='__YOUR_API_KEY__')

try:
    client.order_forms.find_all({'per_page': 20, 'page': 1, 'status[]': ['generated']})
except LagoApiError as e:
    repair_broken_state(e)  # do something on error or raise your own exception

require 'lago-ruby-client'

client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__')

client.order_forms.get_all({ per_page: 20, page: 1, 'status[]': ['generated'] })

await client.orderForms.findAllOrderForms({ per_page: 20, page: 1, "status[]": ["generated"] });

import (
	"context"
	"fmt"

	lago "github.com/getlago/lago-go-client"
)

func main() {
	lagoClient := lago.New().SetApiKey("__YOUR_API_KEY__")
	ctx := context.Background()

	page, perPage := 1, 20
	orderFormResult, err := lagoClient.OrderForm().GetList(ctx, &lago.OrderFormListInput{
		Page:    &page,
		PerPage: &perPage,
		Status:  []lago.OrderFormStatus{lago.OrderFormStatusGenerated},
	})
	if err != nil {
		// Error is *lago.Error
		panic(err)
	}

	// orderFormResult is *lago.OrderFormResult
	fmt.Println(orderFormResult)
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

Page number.

Example:

1

per_page

integer

Number of records per page.

Example:

20

status[]

enum<string>[]

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

Available options:

generated,

signed,

expired,

voided

customer_id[]

string<uuid>[]

Filter order forms by the Lago identifiers of their customers.

Example:

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

number[]

string[]

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

Example:

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

quote_number[]

string[]

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

Example:

["QT-2026-0001"]

owner_id[]

string<uuid>[]

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

Example:

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

search_term

string

Search order forms by number.

Example:

"OF-2026"

created_at_from

string<date-time>

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

Example:

"2026-01-01T00:00:00Z"

created_at_to

string<date-time>

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

Example:

"2026-12-31T23:59:59Z"

expires_at_from

string<date-time>

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

Example:

"2026-01-01T00:00:00Z"

expires_at_to

string<date-time>

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

Example:

"2026-12-31T23:59:59Z"

Response

Order forms

order_forms

object[]

required

Show child attributes