cURL
curl --request GET \
--url 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields' \
--header 'BLINK-API-KEY: <api-key>'import requests
url = "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields"
headers = {"BLINK-API-KEY": "<api-key>"}
response = requests.request("GET", url, headers=headers)
print(response.text)
const url = 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields';
const options = {method: 'GET', headers: {'BLINK-API-KEY': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"BLINK-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("BLINK-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.get("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields")
.header("BLINK-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'
url = URI("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["BLINK-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body
{
"limit": 1000,
"offset": 0,
"total": 36,
"results": [
{
"id": "cec2cd5f-aa25-4e79-ba96-56092f6ed452",
"created_at": 1768820699332,
"updated_at": 1768820699332,
"created_by": "admin@example.com",
"updated_by": "admin@example.com",
"tenant_id": "<tenant-id>",
"workspace_id": "<workspace-id>",
"table_id": "<table-id>",
"name": "name",
"display_name": "Name",
"description": "",
"type": "text",
"attributes": {
"hidden": false,
"protected": true,
"required": true,
"width": 566
},
"indexes": [
{
"name": "cases_name_idx_gin",
"unique": false,
"type": "gin",
"class": "gin_trgm_ops"
}
]
},
{
"id": "7cb362a6-d8e5-4b69-84d5-956d408ada29",
"created_at": 1768820699332,
"updated_at": 1768820699332,
"created_by": "admin@example.com",
"updated_by": "admin@example.com",
"tenant_id": "<tenant-id>",
"workspace_id": "<workspace-id>",
"table_id": "<table-id>",
"name": "status",
"display_name": "Status",
"description": "",
"type": "status",
"attributes": {
"options": [
"OPEN",
"IN PROGRESS",
"CLOSED"
],
"protected": true,
"required": true
},
"indexes": [
{
"name": "cases_status_idx",
"unique": false
}
]
},
{
"id": "e3b36560-dde9-4cee-be3f-0bef64a34a8c",
"created_at": 1768820699332,
"updated_at": 1768820699332,
"created_by": "admin@example.com",
"updated_by": "admin@example.com",
"tenant_id": "<tenant-id>",
"workspace_id": "<workspace-id>",
"table_id": "<table-id>",
"name": "severity",
"display_name": "Severity",
"description": "",
"type": "risk-level",
"attributes": {
"default_value": 1,
"hidden": false,
"protected": true,
"required": true,
"width": 110
},
"indexes": [
{
"name": "cases_severity_idx",
"unique": false
}
]
}
]
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}Case Management
List Fields from Case Management Table
Retrieve the schema of a case management table: each field’s name, display name, type, and attributes, such as the options of a select field.
GET
/
workspace
/
{ws_id}
/
case_management
/
table
/
{table}
/
fields
cURL
curl --request GET \
--url 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields' \
--header 'BLINK-API-KEY: <api-key>'import requests
url = "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields"
headers = {"BLINK-API-KEY": "<api-key>"}
response = requests.request("GET", url, headers=headers)
print(response.text)
const url = 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields';
const options = {method: 'GET', headers: {'BLINK-API-KEY': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"BLINK-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("BLINK-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.get("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields")
.header("BLINK-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'
url = URI("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["BLINK-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body
{
"limit": 1000,
"offset": 0,
"total": 36,
"results": [
{
"id": "cec2cd5f-aa25-4e79-ba96-56092f6ed452",
"created_at": 1768820699332,
"updated_at": 1768820699332,
"created_by": "admin@example.com",
"updated_by": "admin@example.com",
"tenant_id": "<tenant-id>",
"workspace_id": "<workspace-id>",
"table_id": "<table-id>",
"name": "name",
"display_name": "Name",
"description": "",
"type": "text",
"attributes": {
"hidden": false,
"protected": true,
"required": true,
"width": 566
},
"indexes": [
{
"name": "cases_name_idx_gin",
"unique": false,
"type": "gin",
"class": "gin_trgm_ops"
}
]
},
{
"id": "7cb362a6-d8e5-4b69-84d5-956d408ada29",
"created_at": 1768820699332,
"updated_at": 1768820699332,
"created_by": "admin@example.com",
"updated_by": "admin@example.com",
"tenant_id": "<tenant-id>",
"workspace_id": "<workspace-id>",
"table_id": "<table-id>",
"name": "status",
"display_name": "Status",
"description": "",
"type": "status",
"attributes": {
"options": [
"OPEN",
"IN PROGRESS",
"CLOSED"
],
"protected": true,
"required": true
},
"indexes": [
{
"name": "cases_status_idx",
"unique": false
}
]
},
{
"id": "e3b36560-dde9-4cee-be3f-0bef64a34a8c",
"created_at": 1768820699332,
"updated_at": 1768820699332,
"created_by": "admin@example.com",
"updated_by": "admin@example.com",
"tenant_id": "<tenant-id>",
"workspace_id": "<workspace-id>",
"table_id": "<table-id>",
"name": "severity",
"display_name": "Severity",
"description": "",
"type": "risk-level",
"attributes": {
"default_value": 1,
"hidden": false,
"protected": true,
"required": true,
"width": 110
},
"indexes": [
{
"name": "cases_severity_idx",
"unique": false
}
]
}
]
}{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}Authorizations
Use your API key to access BlinkOps API. To generate an API key, please log in to your BlinkOps account and navigate to the API Keys section in the user settings page. Add the generated key to your request headers as BLINK-API-KEY.
Was this page helpful?