> For the complete documentation index, see [llms.txt](https://tsanet.gitbook.io/connect/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tsanet.gitbook.io/connect/api-reference/case-notes.md).

# Case Notes

Notes associated with collaboration requests

## GET /v1/collaboration-requests/{token}/notes

> Get notes for a collaboration request

```json
{"openapi":"3.0.3","info":{"title":"TSANet Connect Core API","version":"1.0.0"},"tags":[{"name":"Case Notes","description":"Notes associated with collaboration requests"}],"servers":[{"url":"http://localhost:8080","description":"Local"},{"url":"https://connect2.tahoelab.us","description":"Dev"},{"url":"https://connect2.tsanet.net","description":"Beta"},{"url":"https://connect2.tsanet.org","description":"Prod"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste a Bearer JWT here. Two token types are accepted:\n\n**Connect1 User Tokens** — issued by the Connect1 identity service. Copy the token from your Connect1 session.\n\n**Azure AD M2M** — use the `azureClientCredentials` scheme below to get a token, then paste it here.\n"}},"schemas":{"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string","maxLength":191},"creatorUsername":{"type":"string","maxLength":191},"creatorEmail":{"type":"string","maxLength":191},"creatorName":{"type":"string","maxLength":191},"summary":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":5000},"priority":{"$ref":"#/components/schemas/NotePriority"},"status":{"$ref":"#/components/schemas/NoteStatus"},"token":{"type":"string","maxLength":20},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"NotePriority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"NoteStatus":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}},"ProblemDetail":{"type":"object","properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string","format":"uri"}},"additionalProperties":true}}},"paths":{"/v1/collaboration-requests/{token}/notes":{"get":{"tags":["Case Notes"],"summary":"Get notes for a collaboration request","operationId":"getNotes","parameters":[{"name":"token","in":"path","required":true,"description":"The token provided by TSANet for the collaboration request","schema":{"type":"string"}},{"name":"updatedAfter","in":"query","required":false,"description":"Filter by notes that were updated after (YYYY-MM-DDTHH:MM:SSZ)","schema":{"type":"string","format":"date-time"}},{"name":"createdAfter","in":"query","required":false,"description":"Filter by notes that were created after (YYYY-MM-DDTHH:MM:SSZ)","schema":{"type":"string","format":"date-time"}},{"name":"includeRemoved","in":"query","required":false,"description":"Filter to include removed notes - excluded by default","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of notes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CaseNoteDTO"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}}}}
```

## POST /v1/collaboration-requests/{token}/notes

> Create a note for a collaboration request

```json
{"openapi":"3.0.3","info":{"title":"TSANet Connect Core API","version":"1.0.0"},"tags":[{"name":"Case Notes","description":"Notes associated with collaboration requests"}],"servers":[{"url":"http://localhost:8080","description":"Local"},{"url":"https://connect2.tahoelab.us","description":"Dev"},{"url":"https://connect2.tsanet.net","description":"Beta"},{"url":"https://connect2.tsanet.org","description":"Prod"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste a Bearer JWT here. Two token types are accepted:\n\n**Connect1 User Tokens** — issued by the Connect1 identity service. Copy the token from your Connect1 session.\n\n**Azure AD M2M** — use the `azureClientCredentials` scheme below to get a token, then paste it here.\n"}},"schemas":{"CaseNoteTemplateDTO":{"required":["description","priority","summary"],"type":"object","properties":{"summary":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":5000},"priority":{"$ref":"#/components/schemas/NotePriority"},"submittedBy":{"$ref":"#/components/schemas/UserDTO"}}},"NotePriority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string","maxLength":191},"firstName":{"type":"string","maxLength":191},"lastName":{"type":"string","maxLength":191},"email":{"type":"string","maxLength":191},"phone":{"type":"string","maxLength":50},"phoneCountryCode":{"type":"string","maxLength":10},"city":{"type":"string","maxLength":191},"emailCheckFailData":{"type":"string","maxLength":191}}},"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string","maxLength":191},"creatorUsername":{"type":"string","maxLength":191},"creatorEmail":{"type":"string","maxLength":191},"creatorName":{"type":"string","maxLength":191},"summary":{"type":"string","maxLength":500},"description":{"type":"string","maxLength":5000},"priority":{"$ref":"#/components/schemas/NotePriority"},"status":{"$ref":"#/components/schemas/NoteStatus"},"token":{"type":"string","maxLength":20},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"NoteStatus":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}},"ProblemDetail":{"type":"object","properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string","format":"uri"}},"additionalProperties":true}}},"paths":{"/v1/collaboration-requests/{token}/notes":{"post":{"tags":["Case Notes"],"summary":"Create a note for a collaboration request","operationId":"createNote","parameters":[{"name":"token","in":"path","required":true,"description":"The token provided by TSANet for the collaboration request","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseNoteTemplateDTO"}}}},"responses":{"200":{"description":"Note created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseNoteDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}}}}
```