For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Documentation API Reference Changelog

Documentation API Reference Changelog

Pivolio

Pivolio Authentication

Sign in

POST

https://host.com/auth/login

POST

/auth/login

$ curl -X POST https://host.com/auth/login \
>      -H "Content-Type: application/json" \
>      -d '{
>   "email": "string",
>   "password": "string"
> }'

1 {
2   "id": "string",
3   "email": "string",
4   "name": "string",
5   "created_at": "2024-01-15T09:30:00Z"
6 }

Authenticates with email and password and starts a session cookie. Returns the signed-in user.

Request

This endpoint expects an object.

emailstringRequiredformat: "email"

passwordstringRequired

Response

Successful Response

idstringformat: "uuid"

emailstring

namestring or null

created_atdatetime

Errors

422

Unprocessable Entity Error

Was this page helpful?

Sign out