Get Documents

POST /v2/organizations/documents/get

Get Documents

cURL

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

Show properties

organizationId · string · required

Organization ID

documentIds · string[]

Array of Document IDs. Limit: Only 30 IDs can be passed at a time.

folderId · string

Folder ID. Filters documents by the given folder ID.

pageSize · number

Number of items to be retrieved per page. Default: 1000.

pageToken · string

Page token retrieved from previous API call.

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"
  }
}

Partial Failures

When you request specific documentIds and any of them cannot be returned, this endpoint returns HTTP 500 and puts a per-item breakdown in error.details, as an array in the same order you sent the IDs.

A missing document is reported as 500 INTERNAL even though nothing went wrong on the server. Branch on the per-item code rather than the HTTP status when deciding whether to retry. Retrying on the status alone will loop on not-found, which will never succeed.

This also means get is not a reliable existence check today: asking whether a document exists and receiving 500 is the expected answer for “no”. Read code to tell that apart from a real failure.

code · string

Why this particular item could not be returned. Present on every entry with "success": false.

Value	Meaning	Safe to retry?
not-found	The document does not exist.	No
internal	A genuine server-side failure.	Yes

{
  "error": {
    "status": "INTERNAL",
    "message": "Error retrieving document(s).",
    "details": [
      {
        "documentName": "yourDocumentName",
        "disabled": false,
        "accessType": "public",
        "id": "yourDocumentId1"
      },
      {
        "id": "yourDocumentId2",
        "success": false,
        "message": "Document does not exist",
        "code": "not-found"
      }
    ]
  }
}

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