Read a client note

GET

/v1/workspaces/{workspaceId}/sharees/{shareeId}/context/{name}

const url = 'https://shareout.site/v1/workspaces/example/sharees/example/context/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://shareout.site/v1/workspaces/example/sharees/example/context/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

shareeId

required

string

name

required

string

Responses

200

Markdown note

text/markdown

string

404

Resource not found

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}