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

# Introduction

> This is the home of the Engagement Agents API specification. Here you can find all the information you need to get started with our public API.

<Note>
  We currently only support GET requests for pulling information into your own website or app. More endpoints will be coming in the future but if you
  require a custom endpoint please contact us.
</Note>

## Authentication

All API endpoints are authenticated using Bearer tokens. This Bearer token will be provided to you when you reach out to our support. To authenticate
your requests, you need to include the Bearer token in the header of your request.

```json theme={null}
{
  "Authorization": "Bearer YOUR_BEARER_TOKEN"
}
```

## Base URL

The base URL for all API requests is `https://services.engagementagents.com/`.

## Rate Limiting

We currently have a rate limit of 1000 requests per minute. If you exceed this limit, you will receive a `429 Too Many Requests` response. If you
require a higher rate limit, please contact us.

## ISO Codes

In the responses, you will see that the `headline`, `description` and `imageUrl` fields are returned in multiple languages. Below you can find a table
of our ISO codes and what languages they represent.

| ISO Code | Language  |
| -------- | --------- |
| en       | English   |
| es       | Spanish   |
| fr       | French    |
| dn       | Danish    |
| sw       | Swedish   |
| nr       | Norwegian |
| pol      | Polish    |
| deu      | German    |
| ndl      | Dutch     |
| cz       | Czech     |

## Campaign Types

When querying Marketing Campaigns, you can filter the results by specific campaign types using the `type` query parameter.

By default, if no `type` is provided, campaigns of all types will be returned.

If you're only interested in certain types, simply include one or more type parameters in your query. For example:

```bash theme={null}
/api/v1/campaigns?type=Sales&type=Events
```

<Note>
  Tip: URL encoding is handled automatically by most tools (such as Swagger UI, Postman, Mintlify). However, if manually crafting a URL, remember to
  encode special characters like a space (' ') as `%20` and slashes (' / ') as `%2F`. For example, when selecting New Arrivals, the URL becomes:
</Note>

```bash theme={null}
/api/v1/campaigns?type=New%20Arrivals
```

Below is a list of the available campaign types and what they represent:

| Type         | Description                                                                                                                                                                                                                   |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Sales        | A marketing campaign that includes a direct incentive to purchase. Examples include percentage discounts, gift with purchase offers, multi-buy deals, and other promotional incentives.                                       |
| Events       | A marketing campaign promoting an in-store event. These may include experiences, workshops, meet-and-greets, or holiday-themed activities. Events may or may not include purchase incentives, depending on the specific case. |
| New Arrivals | A marketing campaign that highlights newly launched products or collections. These campaigns do not include any purchase incentives.                                                                                          |
| Loyalty      | A marketing campaign that includes an incentive to purchase, but the incentive is exclusive to members of a loyalty program (e.g., member-only discounts, early access, or points-based rewards).                             |