Pinal Developers

API reference · v1.0.0

Pinal API

The same API Pinal's own apps use. Authenticate with OAuth 2 (authorization code + PKCE) through Pinal Accounts, then call the endpoints below with the access token as a Bearer token. Each operation lists the scope it needs.

Base URLhttps://api.pinal.tech/v1 openapi.json

Authentication

Send an access token from Sign in with Pinal as a Bearer token. Each endpoint lists the scope it needs.

Errors

Errors use standard HTTP status codes with a JSON body. 401 means the token is missing or expired; 403 means it lacks the scope; 400 names the field at fault when there is one.

HTTP/1.1 403 Forbidden
{
  "error": "insufficient_scope",
  "error_description": "Requires mail.read"
}

Pagination

Lists return a next_cursor. Pass it back as cursor for the next page; it's null on the last one.

GET /v1/mail/messages?limit=25&cursor=c_9Xk2…

{ "messages": [ … ], "next_cursor": "c_Ab73…" }