---
title: "Get customer portal link for a project"
method: POST
path: "/projects/{projectId}/customer-portal-link"
tags: ["Customer Portal"]
---

# Get customer portal link for a project

`POST /projects/{projectId}/customer-portal-link`

## Request

- Base URL: `https://api3.autarc.energy/v1`
- URL: `https://api3.autarc.energy/v1/projects/{projectId}/customer-portal-link`
- Auth: API key in header `X-Api-Key`

Returns a link to the customer portal sign-in for the project's customer. If the customer has never been invited, an invitation is created silently (no email is sent by this call). The link carries no sign-in credential. Opening it shows the company's branded sign-in, which emails the invited address a sign-in link of its own, so a link that passes through your system never opens the customer's account. If the customer has already accepted their invitation and has active portal access, this returns 409.

## Path parameters

- `projectId` string, required

## Response `200`

A customer-portal invite link for the project's customer

- CustomerPortalLinkResponse
  - `customerPortalUrl` string, uri, required: A link to the customer portal sign-in, prefilled with the invited address. It carries no sign-in credential; the customer receives one by email.

## Other responses

- `404`: The specified resource was not found
- `409`: The customer already has active portal access — no new link can be issued.

---

[API](https://skmtc.dev/autarc/apis/autarc-2-0-api.md) - [All operations](https://skmtc.dev/autarc/apis/autarc-2-0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/autarc/apis/autarc-2-0-api/revisions/adfb20a40efc?raw)