API Documentation
Endpoint Examples
Case
Get Case
Case
Get Case
Get a case by its ID
GET
/
cases
/
{id}
curl --request GET \
--url https://local.casebender.com:3000/api/cases/{id} \
--header 'X-Api-Key: <api-key>'
{
"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,
"visibleToAllOrganizations": true,
"severityColor": "<string>",
"severityLabel": "<string>",
"createdAtLabel": "<string>",
"updatedAtLabel": "<string>",
"customFields": {},
"assignee": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"password": "<string>",
"salt": "<string>",
"image": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"status": "active"
},
"createdBy": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"password": "<string>",
"salt": "<string>",
"image": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"status": "active"
},
"tasks": [
{
"id": "<string>",
"title": "<string>",
"mandatory": true,
"description": "<string>",
"assigneeId": "<string>",
"flagged": true,
"dueDate": "<string>",
"status": "<string>",
"caseId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"createdById": "<string>",
"assignee": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"password": "<string>",
"salt": "<string>",
"image": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"status": "active"
}
}
],
"observables": [
{
"id": "<string>",
"caseId": "<string>",
"alertId": "<string>",
"createdById": "<string>",
"createdAt": "<string>",
"observableTypeId": 123,
"data": "<string>",
"startDate": "<string>",
"tlp": 123,
"pap": 123,
"ioc": true,
"sighted": true,
"sightedAt": "<string>",
"details": "<string>",
"attachmentId": "<string>",
"ignoreSimilarity": true,
"observableType": {
"id": 123,
"name": "<string>",
"isAttachment": true
},
"tags": [
{
"id": 123,
"name": "<string>"
}
],
"analyzerResults": [
{
"id": "<string>",
"jobId": "<string>",
"observableId": "<string>",
"analyzerId": "<string>",
"analyzerName": "<string>",
"integrationId": 123,
"status": "Waiting",
"startDate": "<string>",
"endDate": "<string>",
"createdAt": "<string>",
"extraData": {}
}
],
"extraData": {}
}
],
"procedures": [
{
"id": 123,
"description": "<string>",
"occurDate": "<string>",
"patternId": 123,
"createdAt": "<string>",
"caseId": "<string>",
"tacticId": 123,
"alertId": "<string>",
"createdById": "<string>"
}
],
"alerts": [
{
"id": "<string>",
"tinyId": 123,
"title": "<string>",
"description": "<string>",
"statusValue": "<string>",
"caseId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"count": 123,
"severity": 123,
"type": "<string>",
"source": "<string>",
"sourceRef": "<string>",
"externalLink": "<string>",
"tlp": 123,
"pap": 123,
"deletedAt": "<string>",
"assigneeId": "<string>",
"createdById": "<string>",
"visibleToAllOrganizations": true,
"clientId": "<string>",
"clientName": "<string>",
"primaryAlertId": "<string>",
"aiInsights": {},
"customFields": {}
}
],
"tags": [
{
"id": 123,
"name": "<string>"
}
],
"extraData": {},
"status": {
"id": "<string>",
"stage": "New",
"label": "<string>",
"color": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"canDelete": true,
"value": "<string>"
},
"organizations": [
{
"id": "<string>",
"name": "<string>"
}
],
"aiInsights": {}
}
Authorizations
Path Parameters
Response
200
application/json
Successful response
Available options:
active
, locked
, pending
, suspended
Available options:
active
, locked
, pending
, suspended
Available options:
active
, locked
, pending
, suspended
Available options:
Waiting
, InProgress
, Success
, Failure
, Deleted
curl --request GET \
--url https://local.casebender.com:3000/api/cases/{id} \
--header 'X-Api-Key: <api-key>'
{
"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,
"visibleToAllOrganizations": true,
"severityColor": "<string>",
"severityLabel": "<string>",
"createdAtLabel": "<string>",
"updatedAtLabel": "<string>",
"customFields": {},
"assignee": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"password": "<string>",
"salt": "<string>",
"image": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"status": "active"
},
"createdBy": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"password": "<string>",
"salt": "<string>",
"image": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"status": "active"
},
"tasks": [
{
"id": "<string>",
"title": "<string>",
"mandatory": true,
"description": "<string>",
"assigneeId": "<string>",
"flagged": true,
"dueDate": "<string>",
"status": "<string>",
"caseId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"createdById": "<string>",
"assignee": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"password": "<string>",
"salt": "<string>",
"image": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"status": "active"
}
}
],
"observables": [
{
"id": "<string>",
"caseId": "<string>",
"alertId": "<string>",
"createdById": "<string>",
"createdAt": "<string>",
"observableTypeId": 123,
"data": "<string>",
"startDate": "<string>",
"tlp": 123,
"pap": 123,
"ioc": true,
"sighted": true,
"sightedAt": "<string>",
"details": "<string>",
"attachmentId": "<string>",
"ignoreSimilarity": true,
"observableType": {
"id": 123,
"name": "<string>",
"isAttachment": true
},
"tags": [
{
"id": 123,
"name": "<string>"
}
],
"analyzerResults": [
{
"id": "<string>",
"jobId": "<string>",
"observableId": "<string>",
"analyzerId": "<string>",
"analyzerName": "<string>",
"integrationId": 123,
"status": "Waiting",
"startDate": "<string>",
"endDate": "<string>",
"createdAt": "<string>",
"extraData": {}
}
],
"extraData": {}
}
],
"procedures": [
{
"id": 123,
"description": "<string>",
"occurDate": "<string>",
"patternId": 123,
"createdAt": "<string>",
"caseId": "<string>",
"tacticId": 123,
"alertId": "<string>",
"createdById": "<string>"
}
],
"alerts": [
{
"id": "<string>",
"tinyId": 123,
"title": "<string>",
"description": "<string>",
"statusValue": "<string>",
"caseId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"count": 123,
"severity": 123,
"type": "<string>",
"source": "<string>",
"sourceRef": "<string>",
"externalLink": "<string>",
"tlp": 123,
"pap": 123,
"deletedAt": "<string>",
"assigneeId": "<string>",
"createdById": "<string>",
"visibleToAllOrganizations": true,
"clientId": "<string>",
"clientName": "<string>",
"primaryAlertId": "<string>",
"aiInsights": {},
"customFields": {}
}
],
"tags": [
{
"id": 123,
"name": "<string>"
}
],
"extraData": {},
"status": {
"id": "<string>",
"stage": "New",
"label": "<string>",
"color": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"canDelete": true,
"value": "<string>"
},
"organizations": [
{
"id": "<string>",
"name": "<string>"
}
],
"aiInsights": {}
}