Skip to main content

Paligo API

List documents

const headers = {
  'Accept':'application/json'
};

fetch('https://{instance}.paligoapp.com/api/v2/documents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /documents

This endpoint lets you list all the documents in a folder. By default, it will return the documents in the root Documents folder. You can filter what documents are returned using the query parameters. To see a document’s XML content, you must request a specific document.

Responses

Status

Meaning

Description

Schema

200

OK

Successful response.

Inline

[
  {
    "id": 123,
    "name": "My topic",
    "uuid": "UUID-1234-5678",
    "type": "document",
    "creator": "2",
    "owner": "2",
    "author": "2",
    "created_at": 1603622378,
    "modified_at": 1603622378,
    "checkout": "false",
    "checkout_user": "2",
    "parent_resource": 456,
    "taxonomies": [
      {}
    ],
    "content": "<?xml>...",
    "languages": [
      "en",
      "jp",
      "sv"
    ],
    "custom_attributes": [
      {}
    ]
  }
]
In this section: