List document shares
curl --request GET \
--url https://scribe.skeptrune.com/api/docs/{id}/shares \
--cookie scribe_session=import requests
url = "https://scribe.skeptrune.com/api/docs/{id}/shares"
headers = {"cookie": "scribe_session="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: 'scribe_session='}};
fetch('https://scribe.skeptrune.com/api/docs/{id}/shares', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scribe.skeptrune.com/api/docs/{id}/shares",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_COOKIE => "scribe_session=",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://scribe.skeptrune.com/api/docs/{id}/shares"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "scribe_session=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://scribe.skeptrune.com/api/docs/{id}/shares")
.header("cookie", "scribe_session=")
.asString();require 'uri'
require 'net/http'
url = URI("https://scribe.skeptrune.com/api/docs/{id}/shares")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["cookie"] = 'scribe_session='
response = http.request(request)
puts response.read_body{
"shares": [
{
"userId": "usr_3fGhJkLmNpQrStUvWx5y",
"email": "[email protected]",
"name": "Grace Hopper",
"role": "editor",
"createdAt": 1752624000000
}
],
"invites": [
{
"id": "dsi_5aBcDeFgHiJkLmNoPq6r",
"email": "[email protected]",
"role": "commenter",
"pending": true,
"createdAt": 1752624000000
}
]
}{
"error": {
"code": "not_found",
"message": "No such document."
}
}{
"error": {
"code": "not_found",
"message": "No such document."
}
}{
"error": {
"code": "not_found",
"message": "No such document."
}
}Shares
List document shares
Returns every per-user share entry of the document, plus the pending email invites (people invited who have not signed up yet). Callable with a user session or an API key acting as its agent identity.
GET
/
api
/
docs
/
{id}
/
shares
List document shares
curl --request GET \
--url https://scribe.skeptrune.com/api/docs/{id}/shares \
--cookie scribe_session=import requests
url = "https://scribe.skeptrune.com/api/docs/{id}/shares"
headers = {"cookie": "scribe_session="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: 'scribe_session='}};
fetch('https://scribe.skeptrune.com/api/docs/{id}/shares', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scribe.skeptrune.com/api/docs/{id}/shares",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_COOKIE => "scribe_session=",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://scribe.skeptrune.com/api/docs/{id}/shares"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "scribe_session=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://scribe.skeptrune.com/api/docs/{id}/shares")
.header("cookie", "scribe_session=")
.asString();require 'uri'
require 'net/http'
url = URI("https://scribe.skeptrune.com/api/docs/{id}/shares")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["cookie"] = 'scribe_session='
response = http.request(request)
puts response.read_body{
"shares": [
{
"userId": "usr_3fGhJkLmNpQrStUvWx5y",
"email": "[email protected]",
"name": "Grace Hopper",
"role": "editor",
"createdAt": 1752624000000
}
],
"invites": [
{
"id": "dsi_5aBcDeFgHiJkLmNoPq6r",
"email": "[email protected]",
"role": "commenter",
"pending": true,
"createdAt": 1752624000000
}
]
}{
"error": {
"code": "not_found",
"message": "No such document."
}
}{
"error": {
"code": "not_found",
"message": "No such document."
}
}{
"error": {
"code": "not_found",
"message": "No such document."
}
}Authorizations
cookieAuthbearerAuth
Browser session cookie set by the WorkOS sign-in flow.
Path Parameters
Id of the document whose shares to list.
Response
The share entries and pending invites.
All share entries and pending email invites of a document.
Share entries, oldest first.
Show child attributes
Show child attributes
Example:
[
{
"userId": "usr_3fGhJkLmNpQrStUvWx5y",
"email": "[email protected]",
"name": "Grace Hopper",
"role": "editor",
"createdAt": 1752624000000
}
]
Pending email invites — people invited to this document who have not signed up yet.
Show child attributes
Show child attributes
Example:
[
{
"id": "dsi_5aBcDeFgHiJkLmNoPq6r",
"email": "[email protected]",
"role": "commenter",
"pending": true,
"createdAt": 1752624000000
}
]