Open a shared Note collaboration session

GET

/api/v1/collab/shared/{owner}/notes/{id}

const url = 'https://example.com/api/v1/collab/shared/example/notes/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://example.com/api/v1/collab/shared/example/notes/example \
  --header 'Authorization: Bearer <token>'

Opens a shared Note collaboration session. It requires a signed-in User with the data scope. The server checks access to each item named in the request. It can return 401 if the session is missing or expired, 403 if access is denied, 404 if the requested item does not exist, 409 if the request conflicts with the current state, 429 if the request limit is reached and 503 if the service is temporarily unavailable. Route: /api/v1/collab/shared/{owner}/notes/{id}. Inputs: owner, id. Do not automatically replay this operation after an uncertain result.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

owner

required

string

required

string

Responses

101

WebSocket upgrade

403

Access denied

404

Note not found

429

Too many open streams

503

Client stream limit reached