---
title: "List all return portals"
method: GET
path: "/return_portals"
tags: ["Return portals"]
---

# List all return portals

`GET /return_portals`

Returns a list of return portals.

## Query parameters

- `id` integer
- `active` boolean
- `per_page` integer
- `page` integer

## Response `200`

Successful.

- ReturnPortal[]
  - `id` integer — ID of the return portal.
  - `active` boolean — Whether the return portal is active and ready to use.
  - `portal_name` string — Last part of the URL to access the return portal: https://return.shipmondo.com/{portal_name}
  - `carrier_code` string — Carrier code for the carrier that is setup to the return portals.

## Other responses

- `401` — Unauthorized.
- `404` — Resource not found.

---

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