List income invoices
Retrieve a paginated list of income invoices with powerful filtering capabilities.
gigstack Connect: Access other teams' invoices using the team parameter.
Filtering Options:
- Filter by creation date using comparison operators
- Filter by metadata fields using dot or underscore notation (e.g., metadata.order_id or metadata_order_id)
Query parameters
gigstack Connect: Target team ID for multi-team access.
Requires gigstack Connect enabled on your team and shared billing account.
Example: ?team=team_xyz789
Maximum number of items to return (default 50, max 100)
Pagination cursor for the next page of results
Field name to order results by
Sort direction for list queries
Sort direction for the results
Filter results created on or after this timestamp. Accepts Unix timestamp in seconds (e.g., 1733011200), milliseconds (e.g., 1733011200000), or ISO 8601 date string (e.g., 2024-12-01).
Filter results created on or before this timestamp. Accepts Unix timestamp in seconds (e.g., 1735689599), milliseconds (e.g., 1735689599000), or ISO 8601 date string (e.g., 2024-12-31).
Filter by any metadata field using dot notation (e.g., metadata.order_id=ORD-123) or underscore notation (e.g., metadata_order_id=ORD-123). Both formats are supported and equivalent. Uses Typesense search for efficient querying without requiring Firestore indexes.
Page number for pagination when using metadata filters (default 1). Only applies when filtering by metadata fields.
Response
Invoices retrieved successfully
Example response
{
"message": "Items retrieved successfully",
"next": "eyJjcmVhdGVkX2F0IjoxNjc3NjUxMjM0fQ==",
"has_more": true,
"total_results": 150
}