# Faivelo core API

**Canonical:** https://apis.io/apis/faivelo-com/core-api/  
**Provider:** Faivelo — https://apis.io/providers/faivelo-com/  
**Documentation:** https://faivelo.com/docs/api

Faivelo core API is one of 3 APIs that [Faivelo](https://apis.io/providers/faivelo-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Faivelo core API as documented publicly: 16 operations. Contract generated from the documentation by API Evangelist (2026-11-07); not the provider's own document.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/partner/customers` | POST /api/partner/customers |
| POST | `/api/partner/customers/{customerid}/domains` | POST /api/partner/customers/{customerId}/domains |
| GET | `/api/partner/customers/{customerid}/domains/smiledental.example` | GET /api/partner/customers/{customerId}/domains/smiledental.example |
| POST | `/api/partner/customers/{customerid}/domains/smiledental.example/mailboxes` | POST /api/partner/customers/{customerId}/domains/smiledental.example/mailboxes |
| POST | `/api/user/api-keys` | Create an agent API key |
| POST | `/api/v1/mailboxes` | POST /api/v1/mailboxes |
| POST | `/api/v1/mailboxes/my-agent` | Create a mailbox for the agent named "my-agent" |
| GET | `/api/v1/mailboxes/my-agent@yourdomain.com/messages` | GET /api/v1/mailboxes/my-agent@yourdomain.com/messages |
| GET | `/api/v1/mailboxes/my-agent@yourdomain.com/messages/{messageid}` | GET /api/v1/mailboxes/my-agent@yourdomain.com/messages/{messageId} |
| DELETE | `/customers/{id}` | Erase a sandbox customer |
| GET | `/customers/{id}` | Get health and status of a customer |
| POST | `/customers/{id}/api-keys` | Create a mailbox API key for a customer |
| POST | `/customers/{id}/domains/{domain}/plan` | Change the plan for a specific domain of a customer |
| POST | `/customers/{id}/plan` | Move every domain of a customer to a new plan |
| GET | `/domains` | List domains |
| GET | `/domains/{domain}` | Get a domain |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/faivelo-com/openapi/_ae-authored/faivelo-com-core-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/faivelo-com/json-schema/faivelo-com-post-api-partner-customers-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/faivelo-com/json-schema/faivelo-com-post-api-v1-mailboxes-my-agent-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/faivelo-com/json-schema/faivelo-com-post-customers-id-api-keys-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/faivelo-com/json-schema/faivelo-com-post-customers-id-domains-domain-plan-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/faivelo-com/json-schema/faivelo-com-post-api-user-api-keys-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/faivelo-com/json-schema/faivelo-com-post-customers-id-plan-request-schema.json
- **APIsJSON** — https://artifacts.apis.io/faivelo-com/apis.yml

## Other Faivelo APIs (2)

- [Faivelo transactional API](https://apis.io/apis/faivelo-com/transactional-api/)
- [Faivelo v1 API](https://apis.io/apis/faivelo-com/v1-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/faivelo-com/core-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/faivelo-com/.