Skip to main content

Get Inbox

GET/api/v1/mail/inbox

Overview​

Retrieve inbox messages for a registered mailbox. Returns messages sorted by date (newest first) with optional filtering for unread-only messages.

Query Parameters​

emailstringrequired

Email address of the mailbox to query

limitintegerdefault: 20

Maximum number of messages to return (max 100)

offsetintegerdefault: 0

Offset for pagination

unread_onlybooleandefault: false

Only return unread messages

Request​

curl "https://spideriq.ai/api/v1/mail/inbox?email=alice@company.com&limit=10&unread_only=true" \
  -H "Authorization: Bearer <client_id>:<api_key>:<api_secret>"

Response​

{
  "success": true,
  "email": "alice@company.com",
  "total": 47,
  "unread": 3,
  "messages": [
    {
      "id": 1234,
      "thread_id": "<abc123@mail.zoho.com>",
      "direction": "inbound",
      "from_address": "bob@prospect.com",
      "to_addresses": ["alice@company.com"],
      "subject": "Re: Quick question about your services",
      "body_text_preview": "Thanks for reaching out! I'd love to lear...",
      "date": "2026-02-02T10:15:00",
      "is_read": false,
      "is_starred": true,
      "labels": ["lead"]
    }
  ]
}