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

# Pigment - How do I link my account?

## Overview

To authenticate with Pigment, you need:

1. **API Key** — a Pigment API key with the scopes your integration needs (Modeling metadata to list applications).

This guide will show you how to create one.

### Prerequisites

* A Pigment account that can manage API keys in **Workspace settings**. If you don't have a workspace, [start a free trial](https://www.pigment.com/trial/sign-up).

### Step 1: Create an API key

1. Sign in to [Pigment](https://pigment.app/login).
2. In the left sidebar, click **Settings**, then click **API Keys** under **Workspace settings**.

![Pigment Settings sidebar with API Keys highlighted under Workspace settings](https://mintcdn.com/nango/LUw7oNYOFNGeKnVZ/api-integrations/pigment/workspace_settings_api_keys.png?fit=max\&auto=format\&n=LUw7oNYOFNGeKnVZ\&q=85\&s=156eeca57d9858bfe06ca3de7d441fd5)

3. On the **API Keys management** page, click **+ Create API key**.

![Pigment API Keys management page with the Create API key button highlighted](https://mintcdn.com/nango/LUw7oNYOFNGeKnVZ/api-integrations/pigment/create_api_key_button.png?fit=max\&auto=format\&n=LUw7oNYOFNGeKnVZ\&q=85\&s=4b159543fa01c06dbd8e886d10d4af36)

4. Enter a **Name**, keep or change the **Expiration date**, and tick the **Scopes** your integration needs, then click **Generate**:

   * **Modeling metadata** for the metadata endpoints (applications, blocks, views and import configurations).
   * **Import** or **Export** for the import and export endpoints.
   * **Files** for the File Storage endpoints and **Data Flows** for the Data Flow endpoints.

   One key can have several scopes. Tick **Modeling metadata** too if the app you connect to needs to list your applications.

![Pigment Create API Key dialog with a name, an expiration date and the Modeling metadata scope ticked](https://mintcdn.com/nango/LUw7oNYOFNGeKnVZ/api-integrations/pigment/create_api_key_dialog.png?fit=max\&auto=format\&n=LUw7oNYOFNGeKnVZ\&q=85\&s=c0d7b72ee276bbee4c183e9134345456)

5. Copy the key with the copy icon.

![Pigment dialog confirming the API key was generated, with the copy icon highlighted](https://mintcdn.com/nango/pmx5W1BSvpsdPC1u/api-integrations/pigment/api_key_created.png?fit=max\&auto=format\&n=pmx5W1BSvpsdPC1u\&q=85\&s=50dafc50f56bbb7da39b77e73b956bd6)

> [!NOTE]
>
> Pigment shows the key only once. Copy it before you close the dialog. The key inherits the workspace, data visibility and permissions of the user who created it.

> [!TIP]
>
> To call the Audit Logs API, a Security Admin creates an **Audit logs** API key the same way. Keys in the old format with dashes must be regenerated.

### Step 2: Enter your API key in the Connect UI

1. Open the form where you need to authenticate with Pigment.
2. Paste your API key in the **API Key** field.
3. Submit the form. The connection is saved without checking the key: if the key is wrong, the first API request returns an authentication error.

![Pigment Connect UI form with the API Key field](https://mintcdn.com/nango/LUw7oNYOFNGeKnVZ/api-integrations/pigment/form.png?fit=max\&auto=format\&n=LUw7oNYOFNGeKnVZ\&q=85\&s=bea7571ba1afb6bd0af04c4244c585be)

You are now connected to Pigment.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.