Documents
Was this helpful?
Was this helpful?
This endpoint allows you to retrieve a document by its unique identifier (document_id).
The unique identifier of the document
1f5c76c3-e7a3-406f-b51e-7ba220244f1b
This endpoint allows you to delete a document by its unique identifier (document_id).
The unique identifier of the document to delete
1f5c76c3-e7a3-406f-b51e-7ba220244f1b
No content
This endpoint allows you to retrieve a list of documents. You can optionally filter the documents by title using the "title" query parameter.
Filter documents by title (optional)
Sample Document
This endpoint allows you to create a new document with the specified data. The document content is pulled from the definition
parameter.
The icon of the document
🗂
This endpoint allows you to edit the definition of a document by its unique identifier (document_id). The definition of the document maps to the visible content of the document itself.
The unique identifier of the document to edit
1f5c76c3-e7a3-406f-b51e-7ba220244f1b
A description of the resource.
This is a description for a sample table.
Mark down documentation to be added to the resource.
\n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motus
Indicates whether the resource contains personally identifiable information (PII). Values can be - True False
false
Indicates whether the table has been set as verified. Values can be - True False
true
Indicates if the resource is visible to viewers or not. Values can be - True False
true
A list of team IDs that the resource belongs to.
["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]
A list of owner user IDs for the resource.
["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
A list of collection IDs the resource belongs to.
["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]
A list of tag IDs associated with the resources.
["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]
A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.
["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]