---
title: "List Stocktakes"
method: GET
path: "/inventory/stock-takes"
tags: ["StockTakes"]
---

# List Stocktakes

`GET /inventory/stock-takes`

This endpoint retrieves a list of all the stocktakes for the given site.

## Query parameters

- `site_id` string, uuid, required
- `page` integer
- `per_page` integer

## Response `200`

The stocktakes were successfully retrieved

- object
  - `data` StockTake[], required
    - `id` string, uuid, required — The ID of the stocktake.
    - `description` string, required — The description of the stocktake.
    - `status` 'in_progress' | 'complete', required — The status of the stocktake.
    - `currency` string, required — The currency of the stocktake.
    - `created_by_id` string, uuid, nullable, required — The ID of the user who created the stocktake.
    - `created_by` SchemasUserSummary
      - `id` string, uuid, required — The ID of the user
      - `email` string, required
      - `first_name` string, required — The first name of the user
      - `last_name` string, required — The last name of the user
      - `full_name` string, required — The full name of the user
    - `posted_by_id` string, uuid, nullable — The ID of the user who posted the stocktake.
    - `posted_by` SchemasUserSummary
      - `id` string, uuid, required — The ID of the user
      - `email` string, required
      - `first_name` string, required — The first name of the user
      - `last_name` string, required — The last name of the user
      - `full_name` string, required — The full name of the user
    - `items_added` boolean, required — Whether items have been added to the stock take.
    - `site_id` string, uuid, required — The ID of the site the stocktake belongs to.
    - `organisation_id` string, uuid, required — The ID of the organisation this stocktake belongs to.
    - `created_at` string, date-time, required — The date and time the stocktake was created.
    - `posted_at` string, date-time, nullable, required — The date and time the stocktake was posted.
    - `updated_at` string, date-time, required — The date and time the stocktake was last updated.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)