canonical: https://jentic.com/apis/plezi.co/plezi

# Plezi API

Plezi is a marketing automation platform. The API provides access to contacts, events, subscriptions, and contact lists. The API exposes 13 endpoints secured with apiKey authentication.

## For AI agents

Programmatically verify authentication, list contact fields. Covers 13 operations with apiKey authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Verify authentication
- List contact fields
- Create a contact
- Export all contacts
- Get recently updated contacts
- Filter contacts by behavior score

## Use cases

### Payments Operations

Use the Plezi API to perform payments operations programmatically. The API provides 13 endpoints covering core functionality including verify authentication, list contact fields, create a contact.

Example prompt: Call GET / to verify authentication

### Automated Authentication Management

Automate authentication operations by combining multiple Plezi API endpoints. Agents can list contact fields and then create a contact in a single workflow.

Example prompt: Call GET `/settings/contact_fields` to list contact fields, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Plezi API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'verify authentication', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/` | Verify authentication |
| GET | `/settings/contact_fields` | List contact fields |
| POST | `/contacts` | Create a contact |
| GET | `/contacts` | List contacts |
| GET | `/export_all_contacts` | Export all contacts |
| GET | `/contacts_updated` | Get recently updated contacts |
| GET | `/contacts_updated_by_score` | Filter contacts by behavior score |
| GET | `/subscriptions` | Export subscriptions |

## Key resources

- **Authentication** — Operations related to Authentication
- **Contact Lists** — Operations related to Contact Lists
- **Contacts** — Operations related to Contacts
- **Events** — Operations related to Events
- **Settings** — Operations related to Settings

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/plezi.co/plezi/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Plezi API by hand means handling its API key auth against app.plezi.co, then managing contact pagination and update polling yourself. Through Jentic you install once, import the Plezi API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Plezi's contact operations take their filters and payloads in the request body rather than pinning a record in the URL path, so scope the agent to the operations it needs, such as creating a contact or listing contacts. You choose that set, so a write like contact creation is included only if you add it while a read-only agent keeps just the list and export operations.
- **Credential handling:** Your Plezi API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a contact' or 'export all contacts', and Jentic returns the matching Plezi operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Plezi API use?

The Plezi API uses an API key passed in the `X-API-Key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I verify authentication with the Plezi API?

Yes. Use the GET / endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Plezi API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I verify authentication through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'verify authentication'. Jentic returns the matching Plezi API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Plezi API have?

The Plezi API exposes 13 endpoints covering authentication, contact lists, contacts operations.

### Can I limit what my agent is allowed to do with the Plezi API?

Yes. Because you run Jentic One yourself, your own rules decide which Plezi operations and credentials the agent may use. Since Plezi's contact operations take their filters and payloads in the request body rather than pinning a record in the URL path, you scope the agent to just the operations it needs, such as listing contacts and exporting all contacts for a read-only agent. A write like creating a contact is available only if you add that operation to the agent's allowed set.