> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasiye.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List shipments

> Return a paginated list of shipments for the authenticated workspace.

Returns 20 shipments per page, newest first. Results are always scoped to the workspace that owns the API key.

<ParamField path="query.search" type="string">
  Filter by reference, customer name, customer email, or dropoff address.
</ParamField>

<ParamField path="query.status" type="string">
  Delivery status: `pending`, `awaiting_pickup`, `in_transit`, `delivered`, or `cancelled`.
</ParamField>

<ParamField path="query.payment" type="string">
  Payment status: `awaiting_payment`, `paid`, `failed`, or `refunded`.
</ParamField>

<ParamField path="query.page" type="number">
  Page number. Defaults to `1`.
</ParamField>

```bash theme={null}
curl "https://api.kasiye.com/v1/shipments?status=pending&page=1" \
  -H "Authorization: Bearer shp_your_key"
```

<ResponseField name="data" type="object[]" required>
  Shipment objects. See [Retrieve a shipment](/api-reference/retrieve-shipment) for the shape of each item.
</ResponseField>

<ResponseField name="meta" type="object" required>
  Pagination: `current_page`, `last_page`, `per_page` (20), and `total`.
</ResponseField>