Get DM Files
    • Dark
      Light
    • PDF

    Get DM Files

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/im.files

    Get all files in a DM.

    Changelog

    VersionDescription
    0.64.0Change userId to user object in response
    0.59.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authToken of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The userId of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Query parameters
    offset
    integer

    Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.

    Example50
    count
    integer

    The number of items to return.

    Example50
    sort

    List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, { "value": -1, "_id": 1 }

    query

    This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" }}

    fields
    string

    This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }

    roomId
    string

    The roomId of the DM. It is required if username is not provided.

    username
    string

    The username of the user in the DM. It is required if roomId is not provided.

    Responses
    200

    OK

    Example 1
    {
      "files": [
        {
          "_id": "6542e355a2f73c7460e18ef6",
          "name": "2023-11-01_21-13-38.snagx",
          "size": 652277,
          "type": "application/octet-stream",
          "rid": "5fRTXMt7DMJbpPJfhgzvcvpov9G4TxbGFS",
          "userId": "5fRTXMt7DMJbpPJfh",
          "store": "GridFS:Uploads",
          "_updatedAt": "2023-11-01T23:46:29.216Z",
          "complete": true,
          "etag": "7qDc9jBurptfmrAxr",
          "path": "/ufs/GridFS:Uploads/6542e355a2f73c7460e18ef6/2023-11-01_21-13-38.snagx",
          "progress": 1,
          "token": "eAD959d9A8",
          "uploadedAt": "2023-11-01T23:46:29.196Z",
          "uploading": false,
          "url": "http://localhost:3000//ufs/GridFS:Uploads/6542e355a2f73c7460e18ef6/2023-11-01_21-13-38.snagx",
          "typeGroup": "application",
          "user": {
            "_id": "5fRTXMt7DMJbpPJfh",
            "username": "test.john",
            "name": "Test John"
          }
        }
      ],
      "count": 1,
      "offset": 0,
      "total": 1,
      "success": true
    }
    Expand All
    object
    files
    Array of object
    object
    _id
    string
    name
    string
    size
    integer
    type
    string
    rid
    string
    userId
    string
    store
    string
    _updatedAt
    string
    complete
    boolean
    etag
    string
    path
    string
    progress
    integer
    token
    string
    uploadedAt
    string
    uploading
    boolean
    url
    string
    typeGroup
    string
    user
    object
    _id
    string
    username
    string
    name
    string
    count
    integer
    offset
    integer
    total
    integer
    success
    boolean
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.