API access & tokens
API access lets your system submit postcards and campaigns to PostPal programmatically. In the API settings, you create account-bound tokens, use them for authenticated requests and delete them again when needed. API requests are logged so you can inspect errors and usage.
API access is intended for technical integrations that submit postcards or campaigns to PostPal automatically.
Basics:
- You create an API token in the account settings.
- The token authenticates requests for your account.
- You can delete tokens when they are no longer needed.
- PostPal records API requests in the API logs.
Use the developer documentation at
https://app.getpostpal.com/developers/api when you need endpoint details,
required fields or example requests. The machine-readable OpenAPI specification
is available at https://app.getpostpal.com/developers/api/openapi.json; the
Postman collection is available at
https://app.getpostpal.com/developers/api/postman.json.
Frequently asked questions
Where do I create an API token?
Create API tokens in PostPal under Settings > API. The token is bound to the active account.
Can I revoke a token?
Yes. Delete the token in the API settings when it should no longer be used.
Where can I find the API documentation?
The official developer documentation is available at https://app.getpostpal.com/developers/api. OpenAPI is available at https://app.getpostpal.com/developers/api/openapi.json, and Postman at https://app.getpostpal.com/developers/api/postman.json.