---
title: "Get a portal link auth token"
method: GET
path: "/v1/projects/{projectID}/portal-links/{portalLinkID}/refresh_token"
tags: ["Portal Links"]
---

# Get a portal link auth token

`GET /v1/projects/{projectID}/portal-links/{portalLinkID}/refresh_token`

## Request

- Base URL: `https://us.getconvoy.cloud/api`
- URL: `https://us.getconvoy.cloud/api/v1/projects/{projectID}/portal-links/{portalLinkID}/refresh_token`
- Auth: HTTP bearer

This endpoint retrieves a portal link auth token

## Path parameters

- `projectID` string, required
- `portalLinkID` string, required

## Response `200`

OK

- object
  - `message` string
  - `status` boolean
  - `data` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found

## Changes

- **2026-07-20** (v3) `bae289777c91`: 6 breaking, 3 info
  - the response property `allOf[subschema #2]/data` became nullable for the status `400`
  - the response property `allOf[subschema #2]/data` became nullable for the status `401`
  - the response property `allOf[subschema #2]/data` became nullable for the status `404`
  - the `allOf[subschema #2]/data` response's property type changed from `object` to no type for status `400`
  - …5 more
- **2025-08-05** (v3) `180e3a788b5b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getconvoy/apis/convoy-api-reference/changes/v1/projects/:projectID/portal-links/:portalLinkID/refresh_token/get.md)

---

[API](https://skmtc.dev/getconvoy/apis/convoy-api-reference.md) - [All operations](https://skmtc.dev/getconvoy/apis/convoy-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/getconvoy/apis/convoy-api-reference/revisions/d97533451ebd?raw)