---
search:
  tags:
    - Returns
    - GET
seo:
  description: >-
    Any signed in user. Lists the branch returns, newest first, with author and
    credit… Reference for the GET /api/v1/returns endpoint in the PharmaFlow
    API.
sidebar:
  label: List returns
  badge: GET
title: List returns
type: openapi-operation
---
Any signed in user. Lists the branch returns, newest first, with author and credit note. Pass sale_id to narrow the list to the returns raised against a single sale.

`GET /api/v1/returns`

**Responses**

- `200` — A page of returns
- `401` — Not authenticated

Response example, 200:

```json
{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "sale_id": "string",
      "branch_id": "string",
      "processed_by": "string",
      "client_mutation_id": "string",
      "device_id": "string",
      "sync_status": "string",
      "reason": "string",
      "total_refund": "string",
      "created_at": "string",
      "processed_by_name": "string",
      "original_invoice": "string",
      "credit_note_number": "string"
    }
  ]
}
```