---
title: "Retrieve a return portal"
method: GET
path: "/return_portals/{id}"
tags: ["Return portals"]
---

# Retrieve a return portal

`GET /return_portals/{id}`

Returns the details of a return portal.

## Path parameters

- `id` integer, required

## 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.net/shipmondo/apis/shipmondo-api.md) · [All operations](https://skmtc.net/shipmondo/apis/shipmondo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipmondo/shipmondo-api/versions/dbe9a4ea0826/schema)