List all versions of a document

Retrieves all versions of a specific document, ordered by version number descending.

GET /v0/documents/{id}/versions

JavaScript

JavaScript

import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

const versions = await client.documents.versions.list('123e4567-e89b-12d3-a456-426614174000');

console.log(versions.document);

200

{
  "document": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-06T12:34:56.789Z",
    "orgId": "org_123456789",
    "assignee": "user_123456789",
    "scrapeJobId": null
  },
  "versions": [
    {
      "id": "321e4567-e89b-12d3-a456-426614174002",
      "createdAt": "2024-01-06T12:34:56.789Z",
      "modifiedAt": "2024-01-06T12:34:56.789Z",
      "orgId": "org_123456789",
      "title": "API Documentation v2",
      "content": "Updated API documentation...",
      "status": "ACTIVE",
      "versionNumber": 2,
      "documentId": "123e4567-e89b-12d3-a456-426614174000",
      "language": "english",
      "metadata": null,
      "originalSentences": []
    },
    {
      "id": "321e4567-e89b-12d3-a456-426614174001",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "orgId": "org_123456789",
      "title": "API Documentation",
      "content": "Initial API documentation...",
      "status": "ARCHIVED",
      "versionNumber": 1,
      "documentId": "123e4567-e89b-12d3-a456-426614174000",
      "language": "english",
      "metadata": null,
      "originalSentences": []
    }
  ]
}

Authorizations

x-api-key · string · header · required

Your unique Avido API key

x-application-id · string · header · required

Your unique Avido Application ID

Path Parameters

id · string<uuid> · required

The unique identifier of the document

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

200

application/json

Successfully retrieved document versions

Response containing all versions of a document

versions · DocumentVersion · object[] · required

Show child attributes

document · Core Document · object · required

A Core Document represents a piece of content that can be organized hierarchically with parent-child relationships and supports versioning

Show child attributes