---
title: "Public search and list ledger entries"
method: POST
path: "/public/v1/ledger/{company_id}/search"
tags: ["ledger"]
---

# Public search and list ledger entries

`POST /public/v1/ledger/{company_id}/search`

## Path parameters

- `company_id` string, uuid, required

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'owner_name' | 'project_group_id' | 'vintage' | 'status' | 'holding' | 'range_start' | 'range_end'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for Ledger Entries where it can filter based on any of these following fields. No fields are mandatory and the syntax is roughly the same as MongoDB querying.
    - `owner_name` string
    - `project_group_id` string, uuid
    - `vintage` string
    - `status` string
    - `holding` string

## Response `200`

A successful operation

- object
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` LedgerEntryPublic[]
    - `owner_name` string
    - `vintage` string
    - `status` 'active' | 'retired' | 'removed'
    - `range_start` integer
    - `range_end` integer
    - `holding` boolean
    - `serial_number_prefix` string
    - `serial_number_range` string
    - `id` string, uuid

---

[API](https://skmtc.net/validere/apis/carbonhub-api.md) · [All operations](https://skmtc.net/validere/apis/carbonhub-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/validere/carbonhub-api/revisions/053edab62415/schema)