canonical: https://jentic.com/apis/simplelogin.io/simplelogin

# SimpleLogin API

API for SimpleLogin email alias service. Provides endpoints for authentication, managing email aliases, mailboxes, contacts, custom domains, and user settings. The API exposes 25 endpoints secured with apiKey authentication.

## For AI agents

Programmatically user authentication, two-factor authentication. Covers 25 operations with apiKey authentication.

## Scope

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

## Capabilities

- User authentication
- Two-factor authentication
- Register a new account
- Confirm new account with activation code
- Request password reset
- Get current user information
- Update user profile

## Use cases

### CRM Operations

Use the SimpleLogin API to perform crm operations programmatically. The API provides 25 endpoints covering core functionality including user authentication, two-factor authentication, register a new account.

Example prompt: Call POST `/api/auth/login` to user authentication

### Automated Alias Management

Automate alias operations by combining multiple SimpleLogin API endpoints. Agents can two-factor authentication and then register a new account in a single workflow.

Example prompt: Call POST `/api/auth/mfa` to two-factor authentication, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SimpleLogin 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 'user authentication', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/auth/login` | User authentication |
| POST | `/api/auth/mfa` | Two-factor authentication |
| POST | `/api/auth/register` | Register a new account |
| POST | `/api/auth/activate` | Confirm new account with activation code |
| POST | `/api/auth/forgot_password` | Request password reset |
| GET | `/api/user_info` | Get current user information |
| PATCH | `/api/user_info` | Update user profile |
| GET | `/api/stats` | Get user statistics |

## Key resources

- **Alias** — Operations for alias
- **Aliases** — Operations for aliases
- **Api_Key** — Operations for api_key
- **Auth** — Operations for auth
- **Logout** — Operations for logout

## 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:** 62 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 44 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 57 / 100
- **View full report:** https://jentic.com/apis/simplelogin.io/simplelogin/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 SimpleLogin by hand means learning that its key goes in a non-standard Authentication header and carrying it across the login, MFA, and user-info calls yourself. Through Jentic you install once, import SimpleLogin from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** SimpleLogin identifies the caller by the account behind the key rather than a resource id in the URL path, so scope the agent by operations: limit it to the operations it needs, such as reading user info or account stats, and leave out account changes like updating user settings unless you add them.
- **Credential handling:** Your SimpleLogin 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 'log a user in' or 'read account stats', and Jentic returns the matching SimpleLogin operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the SimpleLogin API use?

The SimpleLogin API uses an API key passed in the `Authentication` 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 user authentication with the SimpleLogin API?

Yes. Use the POST `/api/auth/login` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SimpleLogin 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 user authentication through Jentic?

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

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

The SimpleLogin API exposes 25 endpoints covering alias, aliases, api_key operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which SimpleLogin operations and credentials the agent can use. Because SimpleLogin identifies the caller by the account behind the API key rather than a resource id in the URL, you scope the agent by operation: allow only what it needs, such as reading user info (GET `/api/user_info`) or account stats (GET `/api/stats`), and leave out account changes like updating user settings unless you add them. The stored key is injected at execution time, so the agent can call only the operations you permit.
