Get Request Notes

GET

https://{tenant}.atomicwork.com/api/v1/requests/:requestId/notes

GET

/api/v1/requests/:requestId/notes

$ curl -G https://{tenant}.atomicwork.com/api/v1/requests/requestId/notes \
>      -H "X-Workspace-Id: 987654321" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d search_key=error \
>      -d per_page=25 \
>      -d next_page_token=eyJwYWdlIjoxfQ

200Retrieved

1 {
2   "notes": [
3     {
4       "id": "note-1234abcd",
5       "author": "Jane Doe",
6       "createdAt": "2024-06-10T09:15:00Z",
7       "content": "Initial investigation shows a network outage affecting multiple users."
8     },
9     {
10       "id": "note-5678efgh",
11       "author": "John Smith",
12       "createdAt": "2024-06-11T14:45:00Z",
13       "content": "Network team resolved the outage; monitoring for stability."
14     }
15   ],
16   "page": 1,
17   "per_page": 25,
18   "next_page_token": "eyJwYWdlIjoyfQ==",
19   "total_notes": 42
20 }

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

requestIdstringRequired

Query parameters

search_keystringOptional>=1 character

pageintegerRequired>=1Defaults to 1

per_pageintegerOptional10-100Defaults to 25

next_page_tokenstringOptional

Response

Successful response

Authentication

Path parameters

Headers

Query parameters

Response