Get list of posts.

Get paginable list of posts.

GET /api/v3/user-feeds/{userId}

Get list of posts.

cURL

curl --request GET \
  --url https://apix.us.amity.co/api/v3/user-feeds/{userId} \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "<string>",
  "data": {
    "posts": [
      {
        "postId": "<string>",
        "data": {
          "title": "<string>",
          "text": "<string>",
          "fileId": "<string>",
          "thumbnailFileId": "<string>",
          "videoFileId": {
            "original": "<string>",
            "low": "<string>",
            "medium": "<string>",
            "high": "<string>"
          },
          "streamId": "<string>"
        },
        "_id": "<string>",
        "path": "<string>",
        "parentPostId": "<string>",
        "postedUserId": "<string>",
        "postedUserPublicId": "<string>",
        "postedUserInternalId": "<string>",
        "sharedUserId": "<string>",
        "sharedCount": 123,
        "targetId": "<string>",
        "targetPublicId": "<string>",
        "targetInternalId": "<string>",
        "dataType": "text",
        "metadata": {},
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "editedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "reactions": {
          "like": 1
        },
        "reactionsCount": 1,
        "myReactions": [
          "like"
        ],
        "commentsCount": 1,
        "comments": [
          "<string>"
        ],
        "children": [
          "<string>"
        ],
        "childrenNumber": 123,
        "isDeleted": false,
        "hasFlaggedComment": false,
        "hasFlaggedChildren": false,
        "feedId": "<string>",
        "tags": [
          "<string>"
        ],
        "hashtags": [
          "technology",
          "programming",
          "web_development",
          "JavaScript",
          "AI_trends"
        ],
        "mentionees": [
          {
            "userIds": [
              "<string>"
            ],
            "userPublicIds": [
              "<string>"
            ],
            "userInternalIds": [
              "<string>"
            ]
          }
        ],
        "impression": 123,
        "reach": 123,
        "structureType": "text"
      }
    ],
    "postChildren": [
      {
        "postId": "<string>",
        "data": {
          "title": "<string>",
          "text": "<string>",
          "fileId": "<string>",
          "thumbnailFileId": "<string>",
          "videoFileId": {
            "original": "<string>",
            "low": "<string>",
            "medium": "<string>",
            "high": "<string>"
          },
          "streamId": "<string>"
        },
        "_id": "<string>",
        "path": "<string>",
        "parentPostId": "<string>",
        "postedUserId": "<string>",
        "postedUserPublicId": "<string>",
        "postedUserInternalId": "<string>",
        "sharedUserId": "<string>",
        "sharedCount": 123,
        "targetId": "<string>",
        "targetPublicId": "<string>",
        "targetInternalId": "<string>",
        "dataType": "text",
        "metadata": {},
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "editedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "reactions": {
          "like": 1
        },
        "reactionsCount": 1,
        "myReactions": [
          "like"
        ],
        "commentsCount": 1,
        "comments": [
          "<string>"
        ],
        "children": [
          "<string>"
        ],
        "childrenNumber": 123,
        "isDeleted": false,
        "hasFlaggedComment": false,
        "hasFlaggedChildren": false,
        "feedId": "<string>",
        "tags": [
          "<string>"
        ],
        "hashtags": [
          "technology",
          "programming",
          "web_development",
          "JavaScript",
          "AI_trends"
        ],
        "mentionees": [
          {
            "userIds": [
              "<string>"
            ],
            "userPublicIds": [
              "<string>"
            ],
            "userInternalIds": [
              "<string>"
            ]
          }
        ],
        "impression": 123,
        "reach": 123,
        "structureType": "text"
      }
    ],
    "comments": [
      {
        "commentId": "<string>",
        "_id": "<string>",
        "path": "<string>",
        "userId": "<string>",
        "userPublicId": "<string>",
        "userInternalId": "<string>",
        "parentId": "<string>",
        "rootId": "<string>",
        "referenceId": "<string>",
        "dataType": "<string>",
        "dataTypes": [],
        "data": {},
        "metadata": {},
        "childrenNumber": 123,
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "reactions": {
          "like": 1
        },
        "reactionsCount": 1,
        "myReactions": [
          "like"
        ],
        "isDeleted": false,
        "editedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "children": [
          "<string>"
        ],
        "segmentNumber": 1,
        "mentionees": [
          {
            "userIds": [
              "<string>"
            ],
            "userPublicIds": [
              "<string>"
            ],
            "userInternalIds": [
              "<string>"
            ]
          }
        ],
        "attachments": [
          {
            "fileId": "<string>"
          }
        ],
        "targetId": "<string>"
      }
    ],
    "users": [
      {
        "userId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "_id": "<string>",
        "path": "<string>",
        "userInternalId": "<string>",
        "userPublicId": "<string>",
        "roles": [
          "<string>"
        ],
        "permissions": [],
        "displayName": "<string>",
        "profileHandle": "<string>",
        "description": "<string>",
        "avatarFileId": "<string>",
        "avatarCustomUrl": "<string>",
        "flagCount": 123,
        "hashFlag": {
          "bits": 123,
          "hashes": 123,
          "hash": [
            "<string>"
          ]
        },
        "metadata": {},
        "isGlobalBan": true,
        "isBrand": true,
        "isDeleted": true
      }
    ],
    "files": [
      {
        "fileId": "<string>",
        "fileUrl": "<string>",
        "accessType": "public",
        "altText": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "attributes": {
          "name": "<string>",
          "extension": "<string>",
          "size": 123,
          "mimeType": "<string>",
          "metadata": {
            "exif": {},
            "gps": {},
            "height": 123,
            "width": 123,
            "isFull": true
          }
        }
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId · string · required

Query Parameters

sortBy · enum<string> · default: lastCreated

Available options: firstCreated, lastCreated, lastUpdated, firstUpdated

hasFlag · boolean

hasFlag:

• null(default) - Show all posts.
• true - Show only flagged post(or children) or has flagged comment.
• false - Show only no flagged post(and children) and has no flagged comment.

isDeleted · boolean

options · object

Show child attributes

dataTypes · enum<string>[]

post data type to filter

Required array length: 1 - 4 elements

Available options: video, image, file, liveStream

Response

200

application/json

UserFeed Information

status · string

data · object

Show child attributes