Skip to main content

Documents

List and retrieve documents from your workspace.


Document fields

The list endpoint returns these summary fields per document:

FieldTypeDescription
idstringUnique document ID (UUID)
titlestringDocument title
sourcestringOrigin of the document (e.g., slack, github, linear, waterfall)
statusstringDocument status
authorstringAuthor identifier
folder_idstring | nullFolder the document belongs to (if any)
created_atstringISO 8601 creation timestamp
updated_atstringISO 8601 last-updated timestamp

The single-document endpoint (GET /api/v1/documents/:id) returns all columns, including the full document content.


List documents

GET /api/v1/documents

Returns workspace-visible documents, ordered by updated_at (newest first), wrapped in a results array.

Query parameters:

NameTypeDefaultMaxDescription
limitnumber50100Results per page
offsetnumber0Pagination offset
sourcestringComma-separated source filter, e.g. ?source=slack,github

Example:

curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://app.sophic.so/api/v1/documents?limit=10&offset=0"

Response:

{
"results": [
{
"id": "abc123",
"title": "Production Deployment Runbook",
"source": "slack",
"status": "published",
"author": "user@example.com",
"folder_id": null,
"updated_at": "2026-04-01T14:30:00Z",
"created_at": "2026-03-15T10:00:00Z"
}
]
}

Get a document

GET /api/v1/documents/:id

Returns the full document object (not wrapped in results), including content. Returns 404 if the document doesn't exist, belongs to a different workspace, or lives in a folder that isn't workspace-visible.

Example:

curl -H "Authorization: Bearer YOUR_API_KEY" \
https://app.sophic.so/api/v1/documents/abc123