Skip to Content
API ReferenceGET List Inbox
GET/api/v1/inbox

Returns a paginated list of inbox items for the authenticated user.

Parameters

NameTypeRequiredDescription
search_idstringNoFilter by a specific search/project
unread_onlybooleanNoOnly return unread items
saved_onlybooleanNoOnly return saved items
min_scorenumberNoMinimum relevance score (0–100)
typestringNoFilter by type: seo, realtime, or comment
sort_bystringNoSort: score_high, score_low, newest, oldest, upvotes, comments
limitnumberNoItems per page, max 100 (default: 50)
offsetnumberNoNumber of items to skip (default: 0)

Example request

curl -H "Authorization: Bearer rsp_your_key" \
"https://redship.io/api/v1/inbox?unread_only=true&min_score=70&limit=10"

Response

200
{
"data": [
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "post_id": "1abc2de",
    "post_title": "Looking for a tool to automate Reddit outreach",
    "post_url": "https://reddit.com/r/SaaS/comments/1abc2de/...",
    "post_author": "reddit_user",
    "post_subreddit": "SaaS",
    "post_content": "We've been manually replying to posts...",
    "post_created_utc": 1700000000,
    "post_score": 42,
    "post_num_comments": 15,
    "relevance_score": 85,
    "type": "seo",
    "is_read": false,
    "is_saved": false,
    "is_declined": false,
    "matched_keyword": "automation tool",
    "comment_id": null,
    "comment_content": null,
    "created_at": "2024-01-15T10:30:00Z"
  }
],
"count": 42,
"limit": 10,
"offset": 0
}
Last updated on