GET/watchlist/cases/{id}

Get a watchlist case

Returns a single tracked case by its id, including its case identifier, status, risk level and the entities it is linked to.

Overview

Returns a single tracked case by its id, including its case identifier, status, risk level and the entities it is linked to.

Auth API key

Send your API key in the X-CasePrimus-Api-Key header. See Authentication for how to create a key, and Rate limits & errors for how requests are counted.

Parameters

Name	In	Description
`id` string Required	path	The id returned when the resource was created.

Example request

Replace CASEPRIMUS_API_KEY with your key.

Request

BASE="https://api.caseprimus.ai/api/caseprimus/v1"

curl "$BASE/watchlist/cases/CASE_ID" \
  -H "X-CasePrimus-Api-Key: $CASEPRIMUS_API_KEY"

const BASE = "https://api.caseprimus.ai/api/caseprimus/v1";

const res = await fetch(BASE + "/watchlist/cases/CASE_ID", {
  method: "GET",
  headers: {
    "X-CasePrimus-Api-Key": process.env.CASEPRIMUS_API_KEY,
  },
});

const data = await res.json();

import os
import requests

BASE = "https://api.caseprimus.ai/api/caseprimus/v1"

res = requests.request(
    "GET",
    BASE + "/watchlist/cases/CASE_ID",
    headers={"X-CasePrimus-Api-Key": os.environ["CASEPRIMUS_API_KEY"]},
)

data = res.json()

Responses

200The case.

Field	Description
`_id` string
`number` integer
`accountId` string
`watchlistEntityIds` array of string	Every watchlist entity this case is linked to - the same real-world case can be tracked against more than one company.
`caseIdentifier` object
`courtType` enum	`DCSCHCCCNCLTNCLATGSTATDRTDRATCESTAT`
`cnr` string	DC, SC, HC only.
`registrationNumber` string	Format depends on courtType - see the description above.
`filingNumber` string	NCLT/NCLAT/GSTAT only.
`diaryNumber` string	SC, DRT, DRAT, CESTAT only.
`establishmentCode` string	Bench/tribunal code - required for HC (when not using cnr) and every tribunal court type.
`caseType` string	Required alongside registrationNumber for most court types. Valid values depend on courtType; list them with GET /case-lookup/case-types.
`snapshot` object (free-form) or null
`riskLevel` enum	`VERY_HIGHHIGHMODERATELOWUNCLASSIFIED`
`status` enum	`ACTIVEPENDING_BACKOFFICE_REVIEWREJECTEDARCHIVED`
`reviewedAt` integer (int64) or null
`sharedWith` array of object
`type` enum	`teamuser`
`id` string	A team ID when type is 'team', a user ID otherwise.
`created` integer (int64)
`createdBy` string or null
`updated` integer (int64) or null
`updatedBy` string or null

Response 200

{
  "_id": "CPWLC0exampledemo0001",
  "number": 200001,
  "accountId": "CPA0exampledemo0001",
  "watchlistEntityIds": [
    "CPWLE0exampledemo0001"
  ],
  "caseIdentifier": {
    "courtType": "DC",
    "cnr": "DLCT010012342020"
  },
  "snapshot": {
    "parties": {
      "petitioner": "Acme Traders Pvt Ltd",
      "respondent": "Jane Doe"
    },
    "court": "District Court, Delhi",
    "stage": "Arguments"
  },
  "riskLevel": "MODERATE",
  "status": "ACTIVE",
  "reviewedAt": null,
  "sharedWith": [],
  "created": 1757000000000,
  "createdBy": "CPU0exampledemo0001",
  "updated": null,
  "updatedBy": null
}

400Case does not exist.

Response 400

{
  "httpStatusCode": 400,
  "code": 60401,
  "message": "Watchlist case does not exist",
  "appError": true
}

403This case has not been shared with you.

Error responses share one shape, listed on Rate limits & errors.

Get a watchlist case

Overview

Parameters

Example request

Responses

Related