Skip to main content

resources/documents/list (post)

Enumerates all source documents in a scope. This only includes files marked for translation.

With translation memories or termbases (which use the DocumentSet scope), this method yields import operations.

Note that the method does not support the GlobalSearch scope.


(POST) /resources/documents/list


The parameters are a JSON object included in the request body:


The scope object. The segment must be within the scope.

NOTE: This method does not support the Global Search scope.

Mandatory, object
skipUsed for pagination. 0 = get documents from the start. If not specified, value will be 0.Optional, int?
takeUsed for pagination. Number of documents to retrieve. If not set, value will be 30.Optional, int?
nameOptional filter on the name. This is an infix filter.Optional, string?
didOptional filter on a specific document. If specified the system returns information for this specific document only.Optional, int?


A JSON with these properties:


An array of all documents in alphabetical order.

See Document Details (Object) for details. The advanced properties are not included.


The total of documents.

hasmoreBoolean indicating if there are more results available.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.