> ## 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.

# Iterable

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported, a full read of the Iterable instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.iterable.com`.

The Iterable connector supports writing to and reading from the following objects:

* [campaigns](https://api.iterable.com/api/docs#campaigns_campaigns)
* [catalogs](https://api.iterable.com/api/docs#catalogs_listCatalogs)
* [lists](https://api.iterable.com/api/docs#lists_getLists)
* [webhooks](https://api.iterable.com/api/docs#webhooks_getWebhooks)

Iterable allows the following objects to only be read, and not written to:

* [channels](https://api.iterable.com/api/docs#channels_channels)
* [jobs](https://api.iterable.com/api/docs#export_getExportJobs)
* [journeys](https://api.iterable.com/api/docs#workflows_getJourneys)
* [messageTypes](https://api.iterable.com/api/docs#messageTypes_messageTypes)
* [messages](https://api.iterable.com/api/docs#Embedded_Messaging_messages)
* [metadata](https://api.iterable.com/api/docs#metadata_list_tables)
* [templates](https://api.iterable.com/api/docs#templates_getTemplates)

Iterable allows the following objects to only be written to:

* [templatesEmail](https://api.iterable.com/api/docs#templates_upsertEmailTemplate)
* [templatesInApp](https://api.iterable.com/api/docs#templates_upsertInAppTemplate)
* [templatesPush](https://api.iterable.com/api/docs#templates_upsertPushTemplate)
* [templatesSMS](https://api.iterable.com/api/docs#templates_upsertSMSTemplate)
* [users](https://api.iterable.com/api/docs#users_updateUser)

### Example integration

For an example manifest file of an Iterable integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/iterable/amp.yaml).

## 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 Iterable:

* Create a manifest file like the example above.
* Deploy it using the [amp CLI](/cli/overview).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for an API key.
* Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the API key supplied by the customer. Please note that this connector's base URL is `https://api.iterable.com`.

## Creating an API key for Iterable

[Click here](https://app.iterable.com/settings/apiKeys) for more information about generating an API key for Iterable. The UI components will display this link, so that your users can successfully create API keys.