API Examples
Common API usage examples and patterns.
API Examples
This documentation is currently being developed. Check back soon for complete content.
Fetching Transactions
List Invoices
curl -X GET "https://api.suiteportal.io/v1/transactions?type=invoice" \
-H "Authorization: Bearer your_api_key"Get Single Transaction
curl -X GET "https://api.suiteportal.io/v1/transactions/txn_123" \
-H "Authorization: Bearer your_api_key"Filtering and Pagination
With Filters
curl -X GET "https://api.suiteportal.io/v1/transactions?\
type=invoice&\
status=open&\
dateFrom=2025-01-01&\
dateTo=2025-01-31" \
-H "Authorization: Bearer your_api_key"With Pagination
curl -X GET "https://api.suiteportal.io/v1/transactions?\
page=2&\
pageSize=50" \
-H "Authorization: Bearer your_api_key"Working with Entities
List Customers
curl -X GET "https://api.suiteportal.io/v1/entities?type=customer" \
-H "Authorization: Bearer your_api_key"Error Handling
try {
const response = await fetch(url, options);
if (!response.ok) {
const error = await response.json();
console.error('API Error:', error.error.message);
return;
}
const data = await response.json();
// Process data
} catch (err) {
console.error('Network error:', err);
}