> ## Documentation Index
> Fetch the complete documentation index at: https://zenskar.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Customer-facing portal reference

<Note>
  This page is a field-level lookup for the portal session API. For task steps, see [how to use the customer-facing portal](/docs/20240301/product-modules/customers/how-to-guides/customer-facing-portal). For what the portal is and what customers can do there, see [customer-facing portal: concepts](/docs/20240301/product-modules/customers/concepts/customer-facing-portal).
</Note>

## Session request

`POST https://api.zenskar.com/customer/session`

| Parameter      | Location | Required | Description                                                                                       |
| -------------- | -------- | -------- | ------------------------------------------------------------------------------------------------- |
| `organisation` | Header   | Yes      | Your organization ID.                                                                             |
| `X-API-KEY`    | Header   | Yes      | Your API key.                                                                                     |
| `customer_id`  | Body     | Yes      | The ID of the customer to generate a session for.                                                 |
| `return_url`   | Body     | Yes      | The URL the customer is sent to if they leave the portal, for example by clicking your logo.      |
| `idle_timeout` | Body     | No       | Duration of inactivity, in seconds, after which the session expires. Defaults to 3600 (one hour). |

## Session response

| Field           | Description                                                                           |
| --------------- | ------------------------------------------------------------------------------------- |
| `redirect_url`  | The URL to send the customer to, or load in an iframe, to start their portal session. |
| `session_token` | The token backing the session.                                                        |

## What's available in the portal today

| Area                        | Status            |
| --------------------------- | ----------------- |
| Invoices                    | Available         |
| Payments                    | Available         |
| Entitlements                | Available         |
| Profile viewing and editing | Available         |
| Reports                     | Not yet available |

<Note>
  Zenskar's API also supports contracts, payment methods, and portal branding (logo, colors, business profile) as data the portal can draw on. Whether these specific areas are shown in the portal your customers actually see depends on your portal's configuration, so treat them as available capabilities to ask about rather than a guaranteed default view.
</Note>