---
title: "List payments"
method: GET
path: "/payments"
tags: ["Payments"]
---

# List payments

`GET /payments`

## Request

- Base URL: `https://api.groundflag.com/api/v1/public`
- URL: `https://api.groundflag.com/api/v1/public/payments`
- Auth: HTTP bearer

## Query parameters

- `status` string
- `invoice_id` string
- `payment_method` string
- `created_after` string, date-time
- `created_before` string, date-time
- `page` integer
- `per_page` integer

## Response `200`

OK

- object
  - `success` boolean
  - `message` string, nullable
  - `data` object
    - `items` Payment[]
      - `id` string
      - `invoice_id` string, nullable
      - `amount` number
      - `status` string
      - `payment_method` string, nullable
      - `paid_at` string, date-time, nullable
      - `created_at` string, date-time, nullable
    - `meta` PageMeta
      - `current_page` integer
      - `last_page` integer
      - `per_page` integer
      - `total` integer

## Other responses

- `401`: Missing, invalid, revoked or expired token
- `403`: The token lacks the required scope
- `429`: Rate limit reached; retry after the Retry-After header

---

[API](https://skmtc.dev/groundflag/apis/groundflag-public-api.md) · [All operations](https://skmtc.dev/groundflag/apis/groundflag-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/groundflag/apis/groundflag-public-api/revisions/65081b6e09ef?raw)