# pricklymails-com Auth API

**Canonical:** https://apis.io/apis/pricklymails-com/pricklymails-com-auth-api/  
**Provider:** pricklymails-com — https://apis.io/providers/pricklymails-com/  
**Base URL:** https://api.pricklymails.com  
**Documentation:** https://pricklymails.com/docs/overview

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

Registration, login, token refresh, password reset, and 2FA.

## Operations (11)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/auth/2fa/verify` | Completes a sign-in that requires two-factor authentication |
| POST | `/api/auth/confirm` | Confirms an account with the six-digit code mailed at signup, and signs it in |
| POST | `/api/auth/forgot-password` | Requests a password reset email |
| POST | `/api/auth/login` | Signs in with an email and a password |
| POST | `/api/auth/logout` | Signs out by revoking the refresh token in the `prickly_refresh` cookie |
| POST | `/api/auth/refresh` | Exchanges the refresh token for a new access token |
| POST | `/api/auth/register` | Starts account creation with an email and a password |
| POST | `/api/auth/resend-confirmation` | Sends a fresh confirmation code for a signup whose code expired, was burned by… |
| POST | `/api/auth/reset-password` | Sets a new password using the token from the password reset email |
| POST | `/api/auth/signup-preview` | Checks the address a visitor is about to sign up with, through the pipeline… |
| POST | `/api/auth/verify-email-change` | Applies a pending email change with the token from the confirmation email sent… |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/pricklymails-com/openapi/pricklymails-com-auth-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/pricklymails-com/json-schema/pricklymails-com-authorization-server-metadata-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/pricklymails-com/json-schema/pricklymails-com-submit-verification-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/pricklymails-com/json-schema/pricklymails-com-api-key-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/pricklymails-com/json-schema/pricklymails-com-webhook-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/pricklymails-com/json-schema/pricklymails-com-token-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/pricklymails-com/json-schema/pricklymails-com-subscription-response-schema.json

## Other pricklymails-com APIs (12)

- [pricklymails-com Account API](https://apis.io/apis/pricklymails-com/pricklymails-com-account-api/)
- [pricklymails-com Agents API](https://apis.io/apis/pricklymails-com/pricklymails-com-agents-api/)
- [pricklymails-com API Keys API](https://apis.io/apis/pricklymails-com/pricklymails-com-api-keys-api/)
- [pricklymails-com Batches API](https://apis.io/apis/pricklymails-com/pricklymails-com-batches-api/)
- [pricklymails-com Billing API](https://apis.io/apis/pricklymails-com/pricklymails-com-billing-api/)
- [pricklymails-com Config API](https://apis.io/apis/pricklymails-com/pricklymails-com-config-api/)
- [pricklymails-com Jobs API](https://apis.io/apis/pricklymails-com/pricklymails-com-jobs-api/)
- [pricklymails-com Notifications API](https://apis.io/apis/pricklymails-com/pricklymails-com-notifications-api/)
- [pricklymails-com OAuth API](https://apis.io/apis/pricklymails-com/pricklymails-com-oauth-api/)
- [pricklymails-com Sessions API](https://apis.io/apis/pricklymails-com/pricklymails-com-sessions-api/)
- [pricklymails-com Stats API](https://apis.io/apis/pricklymails-com/pricklymails-com-stats-api/)
- [pricklymails-com Subscription API](https://apis.io/apis/pricklymails-com/pricklymails-com-subscription-api/)

## Tags

auth

---

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