List review notes
curl --request GET \
--url https://api.sigmora.org/v1/projects/{projectId}/comments \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sigmora.org/v1/projects/{projectId}/comments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sigmora.org/v1/projects/{projectId}/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"comments": [
{
"id": "<string>",
"body": "<string>",
"compositionId": "<string>",
"revisionId": "<string>",
"parentId": "<string>",
"authorDisplayName": "<string>",
"mine": true,
"fromReviewer": true,
"outputSecond": 123,
"createdAt": "<string>",
"resolvedAt": "<string>"
}
],
"nextCursor": "<string>"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}List review notes
One page of a composition’s review notes. Newest first, 50 per page; the roots of older threads ride along so a reply never renders orphaned. Follow nextCursor. Free.
GET
/
v1
/
projects
/
{projectId}
/
comments
List review notes
curl --request GET \
--url https://api.sigmora.org/v1/projects/{projectId}/comments \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sigmora.org/v1/projects/{projectId}/comments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sigmora.org/v1/projects/{projectId}/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"comments": [
{
"id": "<string>",
"body": "<string>",
"compositionId": "<string>",
"revisionId": "<string>",
"parentId": "<string>",
"authorDisplayName": "<string>",
"mine": true,
"fromReviewer": true,
"outputSecond": 123,
"createdAt": "<string>",
"resolvedAt": "<string>"
}
],
"nextCursor": "<string>"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}Authorizations
A workspace API key.
Path Parameters
The project id.
Required string length:
1 - 200Query Parameters
The composition whose notes to read.
Required string length:
1 - 200nextCursor from the previous page.
Maximum string length:
600