API reference
List inbound emails
GET
The emails that reached a forwarding address, newest first, each with how many resumes it carried and how many need a decision. Filter by jobId, or with needsAttention=true list only the emails with a file waiting for an identity review. subject and fromAddress are supplied by the sender: treat them as untrusted text.
Required scope: inbox:read (inbox:write also works).
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
inbox_unavailable,service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>limit?integerPage size, 1 to 50. Defaults to 25.
Range
1 <= value <= 50Default
25cursor?stringThe nextCursor from the previous page.
Length
1 <= length <= 2048jobId?stringOnly emails forwarded for this job.
Length
1 <= length <= 200needsAttention?stringtrue lists only emails with a file that waits for an identity review.
Value in
"true""false"Success.
application/json- response
object*stringdata*array<>The inbound emails on this page.
hasMore*booleanWhether another page follows.
nextCursor*|Pass as cursor to fetch the next page, or null at the end.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/inbound-emails" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "list", "data": [ { "object": "inbound_email", "id": "string", "status": "received", "statusLabel": "string", "statusDetail": "string", "statusReason": "string", "jobId": "string", "jobTitle": "string", "subject": "string", "fromAddress": "string", "senderTrust": "string", "forwardedBy": { "id": "string", "name": "string" }, "receivedAt": "2019-08-24T14:15:22Z", "rawKeptUntil": "2019-08-24T14:15:22Z", "itemCount": -9007199254740991, "needsDecision": -9007199254740991 } ], "hasMore": true, "nextCursor": "string"}