# Payload Authentication API

**Canonical:** https://apis.io/apis/payloadcms/payload-authentication-api/  
**Provider:** Payload CMS — https://apis.io/providers/payloadcms/  
**Base URL:** https://payloadcms.com/api  
**Documentation:** https://payloadcms.com/

Payload Authentication API is one of 8 APIs that [Payload CMS](https://apis.io/providers/payloadcms/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification.

The Authentication API from Payload — 8 operation(s) for authentication.

## Operations (8)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/{userCollection}/login` | Login and receive a JWT token |
| POST | `/api/{userCollection}/logout` | Logout current session |
| GET | `/api/{userCollection}/me` | Get current authenticated user |
| POST | `/api/{userCollection}/refresh-token` | Refresh the JWT token |
| POST | `/api/{userCollection}/verify/{token}` | Verify a newly-registered user via email token |
| POST | `/api/{userCollection}/forgot-password` | Initiate forgot-password flow |
| POST | `/api/{userCollection}/reset-password` | Reset password using a token |
| POST | `/api/{userCollection}/unlock` | Unlock a locked user account |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/payloadcms/refs/heads/main/openapi/payload-authentication-api-openapi.yml

## Other Payload CMS APIs (7)

- [Payload CMS REST API](https://apis.io/apis/payloadcms/rest-api/)
- [Payload CMS GraphQL API](https://apis.io/apis/payloadcms/graphql-api/)
- [Payload CMS Local API](https://apis.io/apis/payloadcms/local-api/)
- [Payload](https://apis.io/apis/payloadcms/payload/)
- [Payload Collections API](https://apis.io/apis/payloadcms/payload-collections-api/)
- [Payload Globals API](https://apis.io/apis/payloadcms/payload-globals-api/)
- [Payload Preferences API](https://apis.io/apis/payloadcms/payload-preferences-api/)

## Tags

Authentication

---

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