POST
/
v2
/
organizations
/
documents
/
get
curl --request POST \
  --url https://api.velt.dev/v2/organizations/documents/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>",
    "documentIds": [
      "<string>"
    ],
    "folderId": "<string>",
    "pageSize": 123,
    "pageToken": "<string>"
  }
}'
{
  "result": {
    "status": "success",
    "message": "Document(s) retrieved successfully.",
    "data": [
      {
        "documentName": "yourDocumentName",
        "disabled": false,
        "accessType": "public",
        "id": "yourDocumentId",
      }
    ],
    "pageToken": "nextPageToken"
  }
}

Use this API to retrieve specific documents or all documents from an organization.

Prior to using this API, you must:

  • Enable advanced queries option in the console
  • Deploy v4 series of the Velt SDK.

​
Endpoint

POST https://api.velt.dev/v2/organizations/documents/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

​
Example Requests

​
1. Get all documents from organization

{
  "data": {
    "organizationId": "yourOrganizationId",
    "pageSize": 20,
    "pageToken": "8740648311207869"
  }
}

​
2. Get specific documents from organization

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentIds": ["yourDocumentId1", "yourDocumentId2"],
  }
}

​
3. Get documents by organizationId, folderId

{
  "data": {
    "organizationId": "yourOrganizationId",
    "folderId": "yourFolderId"
  }
}

​
Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "Document(s) retrieved successfully.",
    "data": [
      {
        "documentName": "yourDocumentName",
        "disabled": false,
        "accessType": "public",
        "id": "yourDocumentId",
      }
    ],
    "pageToken": "nextPageToken"
  }
}

​
Failure Response

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

{
  "result": {
    "status": "success",
    "message": "Document(s) retrieved successfully.",
    "data": [
      {
        "documentName": "yourDocumentName",
        "disabled": false,
        "accessType": "public",
        "id": "yourDocumentId",
      }
    ],
    "pageToken": "nextPageToken"
  }
}

Was this page helpful?