Document share recipients

GET https://app.sulus.ai/api/v1/kb/knowledge-bases/{knowledge_base}/articles/{article}/share

Get who a document is shared with, and who has a pending invite

Authentication

Send a bearer token created on your dashboard's Developer page:

Authorization: Bearer <YOUR_API_KEY>

Path parameters

knowledge_base string Required

The library.

Validation: the library's UUID

Stored in knowledge_bases.id

article string Required

The document.

Validation: the document's UUID

Stored in knowledge_articles.id

Errors

Status	Meaning	Body
`404`	Document not found, or it does not belong to that library	`{"message":"No query results for model [App\\Models\\KnowledgeArticle] <id>."}`
`403`	Policy denied — outside your organization, or you cannot write to this resource	`{"message":"This action is unauthorized."}`
`401`	Missing or invalid bearer token
`403`	Feature knowledge_docs not enabled for the account

Notes

Requires edit access to the document (share management is limited to whoever can write to it).

curl --request GET \
  --url https://app.sulus.ai/api/v1/kb/knowledge-bases/{knowledge_base}/articles/{article}/share \
  --header 'Authorization: Bearer <YOUR_API_KEY>'

import requests

url = "https://app.sulus.ai/api/v1/kb/knowledge-bases/{knowledge_base}/articles/{article}/share"
headers = {"Authorization": "Bearer <YOUR_API_KEY>"}

response = requests.get(url, headers=headers)
print(response.json())

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://app.sulus.ai/api/v1/kb/knowledge-bases/{knowledge_base}/articles/{article}/share"
	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <YOUR_API_KEY>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

Response 200

{
    "data": {
        "shared": [
            {
                "id": 7,
                "name": "John Doe",
                "email": "[email protected]",
                "can_view": true,
                "can_edit": false
            }
        ],
        "pending": [
            {
                "email": "[email protected]",
                "can_view": true,
                "can_edit": false
            }
        ]
    }
}

{
    "data": {
        "shared": [
            {
                "id": 7,
                "name": "John Doe",
                "email": "[email protected]",
                "can_view": true,
                "can_edit": false
            }
        ],
        "pending": [
            {
                "email": "[email protected]",
                "can_view": true,
                "can_edit": false
            }
        ]
    }
}