> For the complete documentation index, see [llms.txt](https://knowledge.out-smart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledge.out-smart.com/marketplace-packages-and-power-ups/power-ups/customer-portal/enable-portal-api-access.md).

# Enable Portal API access

Portal API access lets external systems interact with portal data.

You enable it in the portal settings.

{% stepper %}
{% step %}

### Open the portal

Open the portal you want to edit.
{% endstep %}

{% step %}

### Open Portal settings

Select **Portal settings** in the left menu.
{% endstep %}

{% step %}

### Enable API access

Turn on **Enabled API**.
{% endstep %}

{% step %}

### Save the settings

Click **Save**.
{% endstep %}

{% step %}

### Review access controls

Check the authentication and integration setup you want to use.
{% endstep %}
{% endstepper %}

### When to use this

Use API access when another system needs to read or submit portal data.

### Frequently asked questions

<details>

<summary>Where do I enable API access?</summary>

In **Portal settings**.

</details>

<details>

<summary>Does API access require extra setup?</summary>

Usually yes.

You also need the right authentication and integration setup.

</details>

<details>

<summary>Should every portal enable API access?</summary>

No.

Only enable it when you need an integration.

</details>

### Related topics

* [**Customer Portal**](/marketplace-packages-and-power-ups/power-ups/customer-portal.md)
* [**Configure portal display settings**](/marketplace-packages-and-power-ups/power-ups/customer-portal/configure-portal-display-settings.md)
* [**Automations for Customer Portal**](/marketplace-packages-and-power-ups/power-ups/unlimited-automations/automations-for-customer-portal.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://knowledge.out-smart.com/marketplace-packages-and-power-ups/power-ups/customer-portal/enable-portal-api-access.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.