Get inbox item

GET/api/v1/inbox/:id

Returns a single inbox item by its ID, including the full Reddit post (or comment) and its current state in your inbox.

Request

Path parameters

idstringrequired

The inbox item UUID.

Response

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

Response fields

data.idstring

The inbox item UUID.

data.post_titlestring

Title of the Reddit post.

data.post_urlstring

Permalink to the post on Reddit.

data.post_subredditstring

Subreddit the post was found in.

data.relevance_scorenumber

How relevant RedShip scored this item (0–100).

data.typestring

seo, realtime, or comment.

data.is_read / is_saved / is_declinedboolean

Current state of the item.

data.matched_keywordstring

The keyword that surfaced this item.

curl -H "Authorization: Bearer rsp_your_key" \
"https://redship.io/api/v1/inbox/550e8400-e29b-41d4-a716-446655440000"

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