Skip to main content
GET
Returns the folder-level documents attached to a folder: guidelines, guideline glossaries, and character lists. These documents apply to every project inside the folder, so they are the API equivalent of the Guidelines panel on a folder in the dashboard. Only the three folder-level document types are returned. Source files attached to individual projects are not included.

Authorizations

This endpoint requires API key authentication. Include your API key in the request header:
  • Header name: X-Api-Key
  • Header value: Your API key from the Ollang dashboard
  • Format: X-Api-Key: your-api-key-here
You can obtain your API key from your Ollang dashboard.

Path Parameters

string
required
The unique identifier of the folder. Retrieve folder IDs with Retrieve All Folders.

Response

An array of folder document objects.
string
Unique identifier of the document. Pass this to Remove Folder Document to detach it.
string
Display name of the document.
string
One of guideline, guideline_glossary, or character_list.
string
Location of the stored document.
number
Size of the document in bytes. May be null for documents attached without a size.
string
Language of the document, when one was supplied at attach time. null otherwise.
string
Identifier of the folder the document belongs to.
string
Identifier of the account that owns the document.
string
When the document was attached, in ISO 8601 format.
string
When the document was last updated, in ISO 8601 format.