Get a list of private messages for a user

GET 
/topics/private-messages/:username.json

Get a list of private messages for a user

Request

Path Parameters

username stringrequired

Responses

200

private messages

application/json

Schema

Schema

users object[]
Array [
id integerrequired
username stringrequired
name stringrequired
avatar_template stringrequired
]
primary_groups undefined[]required
topic_list object
can_create_topic booleanrequired
draft stringnullrequired
draft_key stringrequired
draft_sequence integerrequired
per_page integerrequired
topics object[]
Array [
id integerrequired
title stringrequired
fancy_title stringrequired
slug stringrequired
posts_count integerrequired
reply_count integerrequired
highest_post_number integerrequired
image_url stringnullrequired
created_at stringrequired
last_posted_at stringrequired
bumped booleanrequired
bumped_at stringrequired
archetype stringrequired
unseen booleanrequired
last_read_post_number integerrequired
unread_posts integerrequired
pinned booleanrequired
unpinned stringnullrequired
visible booleanrequired
closed booleanrequired
archived booleanrequired
notification_level integerrequired
bookmarked booleanrequired
liked booleanrequired
views integerrequired
like_count integerrequired
has_summary booleanrequired
last_poster_username stringrequired
category_id stringnullrequired
pinned_globally booleanrequired
featured_link stringnullrequired
allowed_user_count integerrequired
posters object[]
Array [
extras stringrequired
description stringrequired
user_id integerrequired
primary_group_id stringnullrequired
]
participants object[]
Array [
extras stringrequired
description stringnullrequired
user_id integerrequired
primary_group_id stringnullrequired
]
]

Example (from schema)

{
  "users": [
    {
      "id": 0,
      "username": "string",
      "name": "string",
      "avatar_template": "string"
    }
  ],
  "primary_groups": [
    null
  ],
  "topic_list": {
    "can_create_topic": true,
    "draft_key": "string",
    "draft_sequence": 0,
    "per_page": 0,
    "topics": [
      {
        "id": 0,
        "title": "string",
        "fancy_title": "string",
        "slug": "string",
        "posts_count": 0,
        "reply_count": 0,
        "highest_post_number": 0,
        "created_at": "string",
        "last_posted_at": "string",
        "bumped": true,
        "bumped_at": "string",
        "archetype": "string",
        "unseen": true,
        "last_read_post_number": 0,
        "unread_posts": 0,
        "pinned": true,
        "visible": true,
        "closed": true,
        "archived": true,
        "notification_level": 0,
        "bookmarked": true,
        "liked": true,
        "views": 0,
        "like_count": 0,
        "has_summary": true,
        "last_poster_username": "string",
        "pinned_globally": true,
        "allowed_user_count": 0,
        "posters": [
          {
            "extras": "string",
            "description": "string",
            "user_id": 0
          }
        ],
        "participants": [
          {
            "extras": "string",
            "user_id": 0
          }
        ]
      }
    ]
  }
}

Loading...