List available docs
Returns a list of documents accessible by the user, and which they have opened at least once. These are returned in the same order as on the docs page: reverse chronological by the latest event relevant to the user (last viewed, edited, or shared).
Query parameters
Show only docs owned by the user.
Show only published docs.
Search term used to filter down results.
Show only docs copied from the specified doc ID.
If true, returns docs that are starred. If false, returns docs that are not starred.
Show only docs visible within the gallery.
Show only docs belonging to the given workspace.
Show only docs belonging to the given folder.
Maximum number of results to return in this query.
An opaque token used to fetch the next page of results.
Response
List of documents matching the query.
Example response
{
"items": [
{
"id": "AbCDeFGH",
"href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH",
"browserLink": "https://docs.superhuman.com/d/_dAbCDeFGH",
"icon": {
"browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
},
"name": "Product Launch Hub",
"owner": "user@example.com",
"ownerName": "Some User",
"docSize": {
"totalRowCount": 31337,
"tableAndViewCount": 42,
"pageCount": 10
},
"sourceDoc": {
"id": "AbCDeFGH",
"href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH",
"browserLink": "https://docs.superhuman.com/d/_dAbCDeFGH"
},
"createdAt": "2018-04-11T00:18:57.946Z",
"updatedAt": "2018-04-11T00:18:57.946Z",
"published": {
"description": "Hello World!",
"browserLink": "https://docs.superhuman.com/@user/hello-world",
"discoverable": true,
"earnCredit": true,
"categories": [
"Project Management"
]
},
"folder": {
"id": "fl-1Ab234",
"browserLink": "https://docs.superhuman.com/folders/fl-1Ab234",
"name": "My docs"
},
"workspace": {
"id": "ws-1Ab234",
"organizationId": "org-2Bc456",
"browserLink": "https://docs.superhuman.com/docs?workspaceId=ws-1Ab234",
"name": "My workspace"
},
"workspaceId": "ws-1Ab234",
"folderId": "fl-1Ab234"
}
],
"href": "https://docs.superhuman.com/apis/v1/docs?limit=20",
"nextPageToken": "eyJsaW1pd",
"nextPageLink": "https://docs.superhuman.com/apis/v1/docs?pageToken=eyJsaW1pd"
}