List Payouts
GET/api/etsy/instances/:integrationInstance/payouts
List an Etsy connection's payouts (one per Etsy deposit), newest first, each with its accounting readiness and its deposit status in the accounting provider.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Filters: filter[search] (internal id, currency or Etsy deposit entry id), filter[id], filter[accounting_status] (pending, ready, posted, held, error), filter[status] (deposited, needs_review), filter[currency], filter[payout_key], filter[amount.*], filter[payout_date.*], filter[created_at.*].
Sort: id, payout_date, amount, accounting_status (default -payout_date). Pagination: per_page default 10, max 100.
Authentication: Bearer token with the accounting:read scope.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.