List inbox items

GET/api/v1/inbox

Returns a paginated list of the opportunities RedShip found for you on Reddit. Use the query parameters to filter by project, state, score, or type, and to page through results.

Request

Query parameters

search_idstring

Filter by a specific search / project.

unread_onlyboolean

Only return unread items.

saved_onlyboolean

Only return saved items.

min_scorenumber

Minimum relevance score (0–100).

typestring

Filter by type: seo, realtime, or comment.

sort_bystring

score_high, score_low, newest, oldest, upvotes, or comments.

limitnumber

Items per page, max 100 (default 50).

offsetnumber

Number of items to skip (default 0).

Response

Returns a JSON object with a data field containing the result.

Response fields

data[]array

List of inbox items (see Get inbox item for the full shape).

countnumber

Total number of items matching the filters.

limitnumber

The page size used for this response.

offsetnumber

The offset used for this response.

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

Success response200

{
"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
}