API Documentation
Endpoint Examples
Case
Create Case
Create a new case
POST
/
cases
Copy
curl --request POST \
--url https://local.casebender.com:3000/api/cases \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"title": "<string>",
"organizations": [
"<string>"
],
"visibleToAllOrganizations": true,
"description": "<string>",
"statusValue": "<string>",
"severity": 2.5,
"tags": [
{
"id": 123
}
],
"customFields": {},
"tlp": 2,
"pap": 1.5,
"createdAt": "<string>",
"clientId": "<string>",
"clientName": "<string>",
"slaConfig": {
"deadlineHours": 1,
"warningThresholdPercent": 50,
"criticalThresholdPercent": 50,
"businessHours": {
"enabled": true,
"start": "<string>",
"end": "<string>",
"timezone": "<string>",
"workDays": [
3
]
}
}
}'
Copy
{
"id": "<string>",
"tinyId": 123,
"title": "<string>",
"description": "<string>",
"statusValue": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"severity": 123,
"tlp": 123,
"pap": 123,
"deletedAt": "<string>",
"createdById": "<string>",
"assigneeId": "<string>",
"flag": true,
"source": "<string>",
"sourceRef": "<string>",
"type": "<string>",
"visibleToAllOrganizations": true,
"primaryCaseId": "<string>",
"clientId": "<string>",
"slaConfigId": "<string>",
"slaDeadline": "<string>",
"slaStatus": "<string>",
"slaStartedAt": "<string>",
"slaUpdatedAt": "<string>",
"slaPausedAt": "<string>",
"customFields": {},
"extraData": {},
"aiInsights": {}
}
Authorizations
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
Copy
curl --request POST \
--url https://local.casebender.com:3000/api/cases \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"title": "<string>",
"organizations": [
"<string>"
],
"visibleToAllOrganizations": true,
"description": "<string>",
"statusValue": "<string>",
"severity": 2.5,
"tags": [
{
"id": 123
}
],
"customFields": {},
"tlp": 2,
"pap": 1.5,
"createdAt": "<string>",
"clientId": "<string>",
"clientName": "<string>",
"slaConfig": {
"deadlineHours": 1,
"warningThresholdPercent": 50,
"criticalThresholdPercent": 50,
"businessHours": {
"enabled": true,
"start": "<string>",
"end": "<string>",
"timezone": "<string>",
"workDays": [
3
]
}
}
}'
Copy
{
"id": "<string>",
"tinyId": 123,
"title": "<string>",
"description": "<string>",
"statusValue": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"severity": 123,
"tlp": 123,
"pap": 123,
"deletedAt": "<string>",
"createdById": "<string>",
"assigneeId": "<string>",
"flag": true,
"source": "<string>",
"sourceRef": "<string>",
"type": "<string>",
"visibleToAllOrganizations": true,
"primaryCaseId": "<string>",
"clientId": "<string>",
"slaConfigId": "<string>",
"slaDeadline": "<string>",
"slaStatus": "<string>",
"slaStartedAt": "<string>",
"slaUpdatedAt": "<string>",
"slaPausedAt": "<string>",
"customFields": {},
"extraData": {},
"aiInsights": {}
}
Assistant
Responses are generated using AI and may contain mistakes.