Skip to main content
GET
/
evidences
/
{COMPANY_ID}
/
category
/
{CATEGORY_ID}
Get a category by ID
curl --request GET \
  --url https://api.timelockdata.com/api/v1/evidences/{COMPANY_ID}/category/{CATEGORY_ID} \
  --header 'X-API-Key: <api-key>'
{
  "path": "<string>",
  "name": "<string>",
  "status": "<string>",
  "fileIds": [
    {
      "name": "<string>",
      "overlayId": "<string>",
      "mimeType": "<string>",
      "title": "<string>",
      "iconId": "<string>",
      "eventId": 123
    }
  ],
  "digitalTwinsCount": 123,
  "imageId": "<string>",
  "description": "<string>"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

COMPANY_ID
string
required

Company identifier

CATEGORY_ID
string
required

Category identifier

Response

200 - application/json

Category details

path
string
required

Path of the category in the hierarchy

name
string
required

Name of the category

status
string
required

Current status of the category

fileIds
object[]
required

Files associated with the category or subcategory

digitalTwinsCount
number
required

Number of evidences in this category

imageId
string

ID of the category image stored in the database

description
string

Description of the category