staff

List a user's DMails

Changed on

Returns the DMails owned by an arbitrary user. Restricted to accounts carrying the BD auditor flag.

get/staff/users/{user_id}/dmails.json

Request

  • Base URL: https://e621.net
  • URL: https://e621.net/staff/users/{user_id}/dmails.json
  • Auth: one of:
    • none
    • HTTP basic
    • API key in query parameter login and API key in query parameter api_key

Path parameters

user_idinteger required

The unique ID of the user whose DMails to list

Query parameters

pageinteger

The page number to retrieve

limitinteger

The number of DMails to retrieve per page

search[id]string

Filter by DMail ID

search[created_at]string

Filter by creation date

search[updated_at]string

Filter by last update date

search[title_matches]string

Filter by title text

search[message_matches]string

Filter by message body text

search[to_name]string

Filter by recipient username

search[to_id]integer

Filter by recipient user ID

search[from_name]string

Filter by sender username

search[from_id]integer

Filter by sender user ID

search[is_read]boolean

Filter by read status

search[is_deleted]boolean

Filter by deleted status

search[read]boolean

Restrict to read DMails when true, or to unread and undeleted DMails when false

Response

A list of the user's DMails

idinteger required

The unique ID of the DMail

owner_idinteger required

The ID of the user who owns this copy of the DMail

from_idinteger required

The ID of the sender

to_idinteger required

The ID of the recipient

titlestring required

The subject line of the DMail

bodystring required

The body text of the DMail

is_readboolean required

Whether the DMail has been read

is_deletedboolean required

Whether the DMail has been deleted

to_namestring

The recipient's username

from_namestring

The sender's username

created_atstring date-time required

When the DMail was created

updated_atstring date-time required

When the DMail was last updated

Changes