Get All User Data

Get all feature data for a user stored in Velt.

POST /v1/users/data/get

Get All User Data

cURL

curl --request POST \
  --url https://api.velt.dev/v1/users/data/get \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "organizationId": "<string>",
    "userId": "<string>",
    "pageToken": "<string>"
  }
}
'

{
  "result": {
    "status": "success", 
    "message": "Data fetched successfully.",
    "data": {
      "comments": [..], //Upto 100 items. Empty array if no items are found.
      "reactions": [..], //Upto 100 items. Empty array if no items are found.
      "recordings": [..], //Upto 100 items. Empty array if no items are found.
      "notifications": [..] //Upto 100 items. Empty array if no items are found.
    },
    "nextPageToken": "bhdwdqwjs298e39e479ddkeuw==329" //This will be null if there are no more items to fetch.
  }
}

Use this API to get all feature data for a user stored in Velt.

• The data will be paginated and returned in chunks of 100 items per feature data.
• You can use the nextPageToken returned in the response to fetch the next chunk of data.
• If there are no more items to fetch, the nextPageToken will not be returned.
• Here is the data that will be included:
  • User profile data: If they were added to any organization, document or folder.
  • Comments data: All the comments created by the user or where they were involved in.
  • Reactions data: All the reactions created by the user.
  • Notifications data: All the notifications where the user was involved in.
  • Recordings data: All the recordings created by the user.

This API may take a few seconds to return a response depending on the dataset size.

Endpoint

POST https://api.velt.dev/v1/users/data/get

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

organizationId · string · required

The organization Id of the organization that the user is part of.

userId · string · required

The user Id of the user you want to get the data for.

pageToken · string

Page token retrieved from previous API call.

Example Request

{
  "data": {
    "organizationId": "yourOrganizationId",
    "userId": "yourUserId",
    "pageToken": "yourPageToken"
  }
}

Response

Success Response

{
  "result": {
    "status": "success", 
    "message": "Data fetched successfully.",
    "data": {
      "comments": [..], //Upto 100 items. Empty array if no items are found.
      "reactions": [..], //Upto 100 items. Empty array if no items are found.
      "recordings": [..], //Upto 100 items. Empty array if no items are found.
      "notifications": [..] //Upto 100 items. Empty array if no items are found.
    },
    "nextPageToken": "bhdwdqwjs298e39e479ddkeuw==329" // This will be null if there are no more items to fetch.
  }
}

Failure Response

{
   "error": {
       "message": "ERROR_MESSAGE",
       "status": "INVALID_ARGUMENT",
       "code": 500
   }
}

{
  "result": {
    "status": "success", 
    "message": "Data fetched successfully.",
    "data": {
      "comments": [..], //Upto 100 items. Empty array if no items are found.
      "reactions": [..], //Upto 100 items. Empty array if no items are found.
      "recordings": [..], //Upto 100 items. Empty array if no items are found.
      "notifications": [..] //Upto 100 items. Empty array if no items are found.
    },
    "nextPageToken": "bhdwdqwjs298e39e479ddkeuw==329" //This will be null if there are no more items to fetch.
  }
}