---
title: "Retrieve list of shipments called with the API"
method: GET
path: "/shipment-usage"
tags: ["Usages"]
---

# Retrieve list of shipments called with the API

`GET /shipment-usage`

## Request

- Base URL: `https://api.sinay.ai/webhook/api/v1`
- URL: `https://api.sinay.ai/webhook/api/v1/shipment-usage`
- Auth: API key in header `API_KEY`

Retrieve the list of shipments called with the API within the provided timeframe, that usages have a minimum resolution of a month (you cant select the usage for one  week for example, the usage will automatically be for the month of the week provided)

## Query parameters

- `startTime` string, date-time
- `endTime` string, date-time
- `periodicity` 'DAILY' | 'MONTHLY'

## Response `200`

Usage has been recovered

- ShipmentCustomUsages
  - `apis` ShipmentCustomUsagesApis

## Other responses

- `400`: Bad request
- `429`: Too Many Requests
- `500`: An error occurred on server side

---

[API](https://skmtc.dev/safecube/apis/webhook-api.md) - [All operations](https://skmtc.dev/safecube/apis/webhook-api/llms.txt) - [OpenAPI document](https://skmtc.dev/safecube/apis/webhook-api/revisions/86d07c02c618?raw)