API
Protocols & headers
HTTPS-only with TLS 1.3, standard methods, and a small set of platform headers you can rely on.
HTTP methods#
| Method | Use |
|---|---|
| GET | Read resources |
| POST | Create resources, perform actions (always idempotent) |
| PATCH | Partial update of a resource |
| DELETE | Cancel or remove a resource |
Common headers#
| Header | Purpose |
|---|---|
| Authorization | Bearer token (API key or OAuth access token) |
| Idempotency-Key | Safe-retry key on POST writes (24h window) |
| X-Pierflow-Tenant | Override tenant context for partner-of-partner scenarios |
| X-RateLimit-Limit | Returned: requests per minute on your tier |
| X-RateLimit-Remaining | Returned: requests left this minute |
| X-Request-Id | Returned on every response; quote when filing support tickets |
Example response headers#
http
httpHTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01HX7K2A3B4C5D
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 296