API Filters and Query Parameters

Overview

API filters let integrations request only the records they need.

Common filters

?date_from=2026-05-01&date_to=2026-05-31
?entity_type=invoices&action=updated
?user_id=3&page=1&per_page=50
?status=failed&country=Egypt
?ip_address=203.0.113.10

Recommended sync pattern

1. Store last_successful_sync_at in your external system.
2. Request events after that timestamp.
3. Process the response.
4. Save the newest processed timestamp.
5. Retry safely if a request fails.

Best practices

• Always use date filters for recurring jobs.
• Use IDs when possible instead of display names.
• Validate query parameters before sending requests.
• Do not request all data when a smaller range is enough.