---
title: "Get Portal"
method: GET
path: "/api/v1/portal/{token}"
tags: ["portal", "portal"]
---

# Get Portal

`GET /api/v1/portal/{token}`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/portal/{token}`
- Auth: none declared

## Path parameters

- `token` string, required

## Query parameters

- `slug` string, nullable

## Response `200`

Successful Response

- PortalResponse
  - `freelancer_name` string, required
  - `client_name` string, required
  - `client_lang` string, required
  - `workspace_slug` string, nullable
  - `branding` object, required
  - `has_custom_portal` boolean
  - `payments_enabled` boolean
  - `invoices` PortalInvoice[], required
    - `id` integer, required
    - `invoice_number` string, nullable
    - `invoice_date` string, nullable
    - `due_date` string, nullable
    - `total_amount` number, required
    - `status` string, required

## Other responses

- `422`: Validation Error

---

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