# Collaboration Requests

Case creation, retrieval, and management

## POST /v1/collaboration-requests

> Create a new collaboration request

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Collaboration Requests","description":"Case creation, retrieval, and management"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v1/collaboration-requests":{"post":{"tags":["Collaboration Requests"],"summary":"Create a new collaboration request","operationId":"createCollaborationRequest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestDTO"}}},"required":true},"responses":{"200":{"description":"Collaboration request created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"CollaborationRequestDTO":{"required":["customFields","documentId","internalCaseNumber","internalNotes","priority","problemDescription","problemSummary","testSubmission"],"type":"object","properties":{"documentId":{"type":"integer","format":"int64"},"internalCaseNumber":{"type":"string"},"receiverInternalCaseNumber":{"type":"string"},"problemSummary":{"type":"string"},"problemDescription":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"adminNote":{"type":"string"},"escalationInstructions":{"type":"string"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/FieldMetadataDTO"}},"internalNotes":{"type":"array","items":{"$ref":"#/components/schemas/InternalNoteDTO"}},"testSubmission":{"type":"boolean"}}},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}},"FieldMetadataDTO":{"required":["displayOrder","fieldId","label","required","section","type"],"type":"object","properties":{"fieldId":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"label":{"type":"string"},"options":{"type":"string"},"additionalSettings":{"type":"string"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]},"displayOrder":{"type":"integer","format":"int32"},"validationRules":{"type":"string"},"value":{"type":"string"},"selections":{"type":"array","items":{"$ref":"#/components/schemas/SelectionDTO"}},"required":{"type":"boolean"}}},"SelectionDTO":{"type":"object","properties":{"value":{"type":"string"},"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SelectionDTO"}}}},"InternalNoteDTO":{"type":"object","properties":{"note":{"type":"string"}}},"CollaborationRequestStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"submitCompanyName":{"type":"string"},"submitCompanyId":{"type":"integer","format":"int64"},"submitterCaseNumber":{"type":"string"},"receiveCompanyName":{"type":"string"},"receiveCompanyId":{"type":"integer","format":"int64"},"receiverCaseNumber":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"direction":{"type":"string","enum":["OUTBOUND","INBOUND"]},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"respondBy":{"type":"string","format":"date-time"},"feedbackRequested":{"type":"boolean"},"reminderSent":{"type":"boolean"},"priorityNote":{"type":"string"},"escalationInstructions":{"type":"string"},"testCase":{"type":"boolean"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseCustomFieldStatusDTO"}},"submittedBy":{"$ref":"#/components/schemas/UserDTO"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"receiverContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"caseNotes":{"type":"array","items":{"$ref":"#/components/schemas/CaseNoteDTO"}},"caseResponses":{"type":"array","items":{"$ref":"#/components/schemas/CaseResponseDTO"}}}},"CaseCustomFieldStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"fieldName":{"type":"string"},"value":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}},"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"creatorUsername":{"type":"string"},"creatorEmail":{"type":"string"},"creatorName":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CaseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["APPROVAL","INFORMATION_REQUEST","INFORMATION_RESPONSE","REJECTION"]},"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"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"}}}}}}
```

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

> Get a specific collaboration request by token

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Collaboration Requests","description":"Case creation, retrieval, and management"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v1/collaboration-requests/{token}":{"get":{"tags":["Collaboration Requests"],"summary":"Get a specific collaboration request by token","operationId":"getCollaborationRequestByToken","parameters":[{"name":"token","in":"path","description":"The token provided by TSANet for the collaboration request","required":true,"schema":{"type":"string"}},{"name":"includeRemovedNotes","in":"query","description":"Filter to include removed notes - excluded by default","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Collaboration request details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Collaboration request not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"CollaborationRequestStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"submitCompanyName":{"type":"string"},"submitCompanyId":{"type":"integer","format":"int64"},"submitterCaseNumber":{"type":"string"},"receiveCompanyName":{"type":"string"},"receiveCompanyId":{"type":"integer","format":"int64"},"receiverCaseNumber":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"direction":{"type":"string","enum":["OUTBOUND","INBOUND"]},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"respondBy":{"type":"string","format":"date-time"},"feedbackRequested":{"type":"boolean"},"reminderSent":{"type":"boolean"},"priorityNote":{"type":"string"},"escalationInstructions":{"type":"string"},"testCase":{"type":"boolean"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseCustomFieldStatusDTO"}},"submittedBy":{"$ref":"#/components/schemas/UserDTO"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"receiverContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"caseNotes":{"type":"array","items":{"$ref":"#/components/schemas/CaseNoteDTO"}},"caseResponses":{"type":"array","items":{"$ref":"#/components/schemas/CaseResponseDTO"}}}},"CaseCustomFieldStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"fieldName":{"type":"string"},"value":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}},"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"creatorUsername":{"type":"string"},"creatorEmail":{"type":"string"},"creatorName":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CaseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["APPROVAL","INFORMATION_REQUEST","INFORMATION_RESPONSE","REJECTION"]},"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"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"}}}}}}
```

## PATCH /v1/collaboration-requests/{token}

> Update collaboration request submitter details

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Collaboration Requests","description":"Case creation, retrieval, and management"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v1/collaboration-requests/{token}":{"patch":{"tags":["Collaboration Requests"],"summary":"Update collaboration request submitter details","operationId":"updateCollaborationRequestSubmitter","parameters":[{"name":"token","in":"path","description":"The token provided by TSANet for the collaboration request","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestSubmitterUpdateDTO"}},"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestSubmitterUpdateDTO"}}},"required":true},"responses":{"200":{"description":"Collaboration request updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Access denied - only the submitter can update these details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Collaboration request not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"CollaborationRequestSubmitterUpdateDTO":{"type":"object","properties":{"internalCaseNumber":{"$ref":"#/components/schemas/JsonNullableString"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"}}},"JsonNullableString":{"type":"object","properties":{"present":{"type":"boolean"}},"description":"Internal case number for the submitter's tracking system"},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}},"CollaborationRequestStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"submitCompanyName":{"type":"string"},"submitCompanyId":{"type":"integer","format":"int64"},"submitterCaseNumber":{"type":"string"},"receiveCompanyName":{"type":"string"},"receiveCompanyId":{"type":"integer","format":"int64"},"receiverCaseNumber":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"direction":{"type":"string","enum":["OUTBOUND","INBOUND"]},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"respondBy":{"type":"string","format":"date-time"},"feedbackRequested":{"type":"boolean"},"reminderSent":{"type":"boolean"},"priorityNote":{"type":"string"},"escalationInstructions":{"type":"string"},"testCase":{"type":"boolean"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseCustomFieldStatusDTO"}},"submittedBy":{"$ref":"#/components/schemas/UserDTO"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"receiverContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"caseNotes":{"type":"array","items":{"$ref":"#/components/schemas/CaseNoteDTO"}},"caseResponses":{"type":"array","items":{"$ref":"#/components/schemas/CaseResponseDTO"}}}},"CaseCustomFieldStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"fieldName":{"type":"string"},"value":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}},"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"creatorUsername":{"type":"string"},"creatorEmail":{"type":"string"},"creatorName":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CaseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["APPROVAL","INFORMATION_REQUEST","INFORMATION_RESPONSE","REJECTION"]},"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"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"}}}}}}
```

## GET /v2/collaboration-requests

> Get collaboration requests (paginated)

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Collaboration Requests","description":"Case creation, retrieval, and management"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v2/collaboration-requests":{"get":{"tags":["Collaboration Requests"],"summary":"Get collaboration requests (paginated)","operationId":"getCollaborationRequestsPaginated","parameters":[{"name":"internalCaseNumber","in":"query","description":"Your internal case number","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter by collaboration request type (optional) - all by default","required":false,"schema":{"type":"string","default":"ALL","enum":["ALL","INBOUND","OUTBOUND"]}},{"name":"status","in":"query","description":"Filter by collaboration request status (optional) - all by default","required":false,"schema":{"type":"string","default":"ALL","enum":["ALL","OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED","PENDINGACTION"]}},{"name":"includeRemovedNotes","in":"query","description":"Include removed notes - excluded by default","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Page number (0-based)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Page size (0 means return all records)","required":false,"schema":{"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Paginated list of collaboration requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponse"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/PagedResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}}},"components":{"schemas":{"PagedResponse":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}},"number":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"first":{"type":"boolean"},"last":{"type":"boolean"}}},"CollaborationRequestStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"submitCompanyName":{"type":"string"},"submitCompanyId":{"type":"integer","format":"int64"},"submitterCaseNumber":{"type":"string"},"receiveCompanyName":{"type":"string"},"receiveCompanyId":{"type":"integer","format":"int64"},"receiverCaseNumber":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"direction":{"type":"string","enum":["OUTBOUND","INBOUND"]},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"respondBy":{"type":"string","format":"date-time"},"feedbackRequested":{"type":"boolean"},"reminderSent":{"type":"boolean"},"priorityNote":{"type":"string"},"escalationInstructions":{"type":"string"},"testCase":{"type":"boolean"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseCustomFieldStatusDTO"}},"submittedBy":{"$ref":"#/components/schemas/UserDTO"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"receiverContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"caseNotes":{"type":"array","items":{"$ref":"#/components/schemas/CaseNoteDTO"}},"caseResponses":{"type":"array","items":{"$ref":"#/components/schemas/CaseResponseDTO"}}}},"CaseCustomFieldStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"fieldName":{"type":"string"},"value":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}},"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"creatorUsername":{"type":"string"},"creatorEmail":{"type":"string"},"creatorName":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CaseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["APPROVAL","INFORMATION_REQUEST","INFORMATION_RESPONSE","REJECTION"]},"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"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"}}}}}}
```

## GET /v2/collaboration-requests/list

> List collaboration requests

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"tags":[{"name":"Collaboration Requests","description":"Case creation, retrieval, and management"}],"servers":[{"url":"http://connect2.tsanet.org","description":"Generated server url"}],"security":[{"bearerAuth":[]}],"paths":{"/v2/collaboration-requests/list":{"get":{"tags":["Collaboration Requests"],"summary":"List collaboration requests","operationId":"listCollaborationRequests","parameters":[{"name":"internalCaseNumber","in":"query","description":"Your internal case number","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter by collaboration request type (optional) - all by default","required":false,"schema":{"type":"string","default":"ALL","enum":["ALL","INBOUND","OUTBOUND"]}},{"name":"status","in":"query","description":"Filter by collaboration request status (optional) - all by default","required":false,"schema":{"type":"string","default":"ALL","enum":["ALL","OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED","PENDINGACTION"]}},{"name":"updatedAfter","in":"query","description":"Filter by requests updated after (YYYY-MM-DDTHH:MM:SSZ)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdAfter","in":"query","description":"Filter by requests created after (YYYY-MM-DDTHH:MM:SSZ)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"includeRemovedNotes","in":"query","description":"Include removed notes - excluded by default","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of collaboration requests","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}}},"application/problem+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetail"}}}}}}}},"components":{"schemas":{"CollaborationRequestStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"submitCompanyName":{"type":"string"},"submitCompanyId":{"type":"integer","format":"int64"},"submitterCaseNumber":{"type":"string"},"receiveCompanyName":{"type":"string"},"receiveCompanyId":{"type":"integer","format":"int64"},"receiverCaseNumber":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"direction":{"type":"string","enum":["OUTBOUND","INBOUND"]},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"respondBy":{"type":"string","format":"date-time"},"feedbackRequested":{"type":"boolean"},"reminderSent":{"type":"boolean"},"priorityNote":{"type":"string"},"escalationInstructions":{"type":"string"},"testCase":{"type":"boolean"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseCustomFieldStatusDTO"}},"submittedBy":{"$ref":"#/components/schemas/UserDTO"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"receiverContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"caseNotes":{"type":"array","items":{"$ref":"#/components/schemas/CaseNoteDTO"}},"caseResponses":{"type":"array","items":{"$ref":"#/components/schemas/CaseResponseDTO"}}}},"CaseCustomFieldStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"fieldName":{"type":"string"},"value":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}},"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"creatorUsername":{"type":"string"},"creatorEmail":{"type":"string"},"creatorName":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CaseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["APPROVAL","INFORMATION_REQUEST","INFORMATION_RESPONSE","REJECTION"]},"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"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"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://tsanet.gitbook.io/connect/api-reference/collaboration-requests.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.