v1
latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KBList documents
Returns all documents in a project that the authenticated user has read access to. A Document is a source file — an HTML or DOCX file — that has been uploaded to Phrase Strings and whose content is segmented into translation keys for localization.
Use this endpoint to enumerate documents before downloading, previewing, or triggering translation workflows for individual files.
The q parameter performs a prefix match on the document name (case-insensitive). For example, passing q=invoice returns documents whose names begin with "invoice" but not documents containing "invoice" elsewhere in the name.
Path parameters
Project ID
Query parameters
Page number
Limit on the number of objects to be returned, between 1 and 100. 25 by default
Filter documents by name prefix. Returns documents whose name starts with the given value (case-insensitive).
Headers
Two-Factor-Authentication token (optional)
Response
OK
Example response
[
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "email.html",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z"
}
]