List POP3 pickup sources
Returns all configured POP3 pickup sources for this mailbox with pagination.
bearerAuthAuthorizationBearer <token>Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.
oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.
oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.
Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].
mailboxId*stringMailbox ULID identifier
limit?integerPage size (default 100)
1 <= value <= 200cursor?stringOpaque page cursor from a previous response
Page of pickup sources
application/json- response
nextCursor?stringOpaque cursor for the next page; absent on the last page
pickups*array<>curl -X GET 'https://api.open.email/api/v1/mailboxes/string/pickups'{
"nextCursor": "string",
"pickups": [
{
"completedAt": 0,
"consecutiveFailures": 0,
"createdAt": 0,
"deleteAfterFetch": true,
"dispatch": {
"consecutiveFailures": 0,
"detail": "string",
"lastAttemptAt": 0,
"nextRunAt": 0,
"outcome": "dispatched"
},
"enabled": true,
"host": "string",
"id": "string",
"importedTotal": 0,
"intervalMinutes": 0,
"labelName": "string",
"lastError": "string",
"lastImportedCount": 0,
"lastOversizeCount": 0,
"lastRunAt": 0,
"lastStatus": "ok",
"mailboxId": "string",
"markRead": true,
"mode": "sync",
"name": "string",
"port": 0,
"quietDays": 0,
"quietSince": 0,
"tls": "tls",
"username": "string"
}
]
}