GET · Bearer

GET /api/v1/inboxes?q=support&limit=100

Summary

List inboxes for the key. Optional q is a case-insensitive substring of email, username, or display_name, and prefix matches come first. % and _ match those characters. Optional label= returns only inboxes that carry that label. Optional status=active or status=paused filters by pause state. Unknown status returns 400 invalid_status. limit defaults to 100 and cannot exceed 500 (400 invalid_limit). page_token continues the list. The response includes next_page_token. A bad page_token returns 400 invalid_page_token. There is no /inboxes/search path, because that would shadow an inbox named search.

Query

?q=support&limit=100

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

  • HTTP 400 invalid_status
  • HTTP 400 invalid_limit
  • HTTP 400 invalid_page_token

Idempotency

This route does not document Idempotency-Key or client_id.