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

# Flatfile

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental reading is only supported for `events`. For all other objects, a full read of the Flatfile instance will be done per scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.x.flatfile.com`.

### Supported Objects

The Flatfile connector supports reading from the following objects:

* [apps](https://reference.flatfile.com/api-reference/apps/list)
* [prompts](https://reference.flatfile.com/api-reference/assistant/list)
* [environments](https://reference.flatfile.com/api-reference/environments/list)
* [events](https://reference.flatfile.com/api-reference/events/list)
* [files](https://reference.flatfile.com/api-reference/files/list)
* [jobs](https://reference.flatfile.com/api-reference/jobs/list)
* [mapping](https://reference.flatfile.com/api-reference/mapping/list-mapping-programs)
* [roles](https://reference.flatfile.com/api-reference/roles/list)
* [spaces](https://reference.flatfile.com/api-reference/spaces/list)
* [users](https://reference.flatfile.com/api-reference/users/list)
* [workbooks](https://reference.flatfile.com/api-reference/workbooks/list)

The Flatfile connector supports writing to the following objects:

* [apps](https://reference.flatfile.com/api-reference/apps/create)
* [prompts](https://reference.flatfile.com/api-reference/assistant/create)
* [environments](https://reference.flatfile.com/api-reference/environments/create)
* [events](https://reference.flatfile.com/api-reference/events/create)
* [files](https://reference.flatfile.com/api-reference/files/upload)
* [jobs](https://reference.flatfile.com/api-reference/jobs/create)
* [mapping](https://reference.flatfile.com/api-reference/mapping/create-mapping-program)
* [spaces](https://reference.flatfile.com/api-reference/spaces/create)
* [workbooks](https://reference.flatfile.com/api-reference/workbooks/create)

## Before you get started

This connector uses API Key authentication. You do not need to create a provider app in the Ampersand Dashboard.

Flatfile distinguishes a **Secret key** from a **Publishable key**. Server-side access through Ampersand uses the Secret key.

### Create a Flatfile secret key

1. Log in to your [Flatfile account](https://platform.flatfile.com/).
2. Navigate to your developer or API key settings.
3. Copy the Secret key for the environment you want to connect.
4. Store the key securely.

<img src="https://mintcdn.com/ampersand-24eb5c1a/tQsAMaB3w4GkZfYk/images/provider-guides/flatfile-api-key.gif?s=f1522f967b536e0251770f701ae8668a" alt="Flatfile secret key creation" width="494" height="336" data-path="images/provider-guides/flatfile-api-key.gif" />

For details, see Flatfile's [authentication documentation](https://reference.flatfile.com/overview/auth).

## Using the connector

This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. Provider apps are only required for providers that use OAuth2 Authorization Code grant type.

To start integrating with Flatfile:

* Create a manifest file like the [example](https://github.com/amp-labs/samples/blob/main/flatfile/amp.yaml).
* Deploy it using the [amp CLI](/cli/overview).
* If you are using Read Actions, create a [destination](/destinations).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for an API key.
* Start using the connector!
  * If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
  * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
  * If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.

## API documentation

For more detailed information about Flatfile API, refer to the [Flatfile API documentation](https://reference.flatfile.com/overview/welcome).