Skip to main content

List receiving inboxes

GET 
/v1/receiving-inbox

Retrieve all receiving email inboxes configured for the authenticated API user's customer.

Environment-Aware Email Addresses: The current_receiving_inbox field returns the appropriate email address based on the NODE_ENV environment variable:

  • development: Returns dev_email_address
  • test: Returns test_email_address
  • production: Returns email_address

Active Status Filtering: By default, only active inboxes are returned. Use the includeInactive=true query parameter to include inactive inboxes.

Response Fields:

  • current_receiving_inbox: Email address for current environment
  • dev_receiving_inbox: Development environment email
  • test_receiving_inbox: Test environment email
  • prod_receiving_inbox: Production environment email
  • default_receiving_inbox: Boolean indicating if this is the default inbox
  • allow_manual_file_upload: Boolean for manual UI upload permission
  • allow_api_file_upload: Boolean for API file upload permission
  • allow_api_invoice_upload: Boolean for API invoice upload permission
  • active: Boolean indicating if inbox is active

Request​

Responses​

Successfully retrieved receiving inboxes