Endpoint search

Search the buyer API

178 endpoints across 23 resources. Search by path, method or what you want to do - paste a real URL and its ids match the path's parameters.

Try

API reference

The Pleaxy API is a REST API with JSON requests and responses. Use it to read and create purchase orders and invoices, and to follow them through approval and payment. For concepts and guides, see the documentation.

Authentication

Send one of two headers with every request:

  • X-Api-Key: <keyId>.<secret> - an API key, for your own systems and agents.
  • Authorization: Bearer <accessToken> - a signed-in person's session, required for a few actions such as approving and managing API keys.

A credential works in one workspace, as a buyer or a supplier. Every path includes that workspace's id as regionId; copy it from Company profile → Workspace ID in Pleaxy.

Errors

Errors use 4xx status codes and a JSON body. Branch on code, not on the English message; messageId and params let you show the message in your own language.

Versioning

Paths start with the version, /v1. New endpoints, fields and values are added within it, so ignore fields you don't recognize and keep a default for unknown values such as statuses. Breaking changes come as a new version.

Base URL
https://api.pleaxy.ai
Authenticated request
curl "$PLEAXY_API_BASE_URL/v1/workspaces/$WORKSPACE_ID/purchase-orders" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Error
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Invoice INV-7F3A9C21 not found.",
  "code": "string",
  "messageId": "string",
  "params": { ... }
}

Resources

Talk to us