Get vendor details | Comp AI API

Retrieve one vendor record with ownership, review status, risk context, and third-party compliance metadata.

GET /v1/vendors/{id}

Get vendor details

cURL

curl --request GET \
  --url https://api.trycomp.ai/v1/vendors/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.trycomp.ai/v1/vendors/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/vendors/{id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "id": "vnd_abc123def456",
  "name": "CloudTech Solutions Inc.",
  "description": "Cloud infrastructure provider offering AWS-like services including compute, storage, and networking solutions for enterprise customers.",
  "category": "cloud",
  "status": "not_assessed",
  "inherentProbability": "possible",
  "inherentImpact": "moderate",
  "residualProbability": "unlikely",
  "residualImpact": "minor",
  "website": "https://www.cloudtechsolutions.com",
  "organizationId": "org_abc123def456",
  "assigneeId": "mem_abc123def456",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "[e-mail]"
  }
}

{
  "message": "Invalid or expired API key"
}

{
  "message": "Vendor with ID vnd_abc123def456 not found in organization org_abc123def456"
}

{
  "message": "Internal server error"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

id · string · required

Vendor ID

Example:

"vnd_abc123def456"

Response

200

application/json

Vendor retrieved successfully

id · string

Vendor ID

Example:

"vnd_abc123def456"

name · string

Vendor name

Example:

"CloudTech Solutions Inc."

description · string

Vendor description

Example:

"Cloud infrastructure provider offering AWS-like services including compute, storage, and networking solutions for enterprise customers."

category · enum<string>

Available options: cloud, infrastructure, software_as_a_service, finance, marketing, sales, hr, other

Example:

"cloud"

status · enum<string>

Available options: not_assessed, in_progress, assessed

Example:

"not_assessed"

inherentProbability · enum<string>

Available options: very_unlikely, unlikely, possible, likely, very_likely

Example:

"possible"

inherentImpact · enum<string>

Available options: insignificant, minor, moderate, major, severe

Example:

"moderate"

residualProbability · enum<string>

Available options: very_unlikely, unlikely, possible, likely, very_likely

Example:

"unlikely"

residualImpact · enum<string>

Available options: insignificant, minor, moderate, major, severe

Example:

"minor"

website · string | null

Example:

"https://www.cloudtechsolutions.com"

organizationId · string

Example:

"org_abc123def456"

assigneeId · string | null

ID of the user assigned to manage this vendor

Example:

"mem_abc123def456"

createdAt · string<date-time>

When the vendor was created

updatedAt · string<date-time>

When the vendor was last updated

authType · enum<string>

How the request was authenticated

Available options: api-key, session

authenticatedUser · object

User information (only for session auth)

Show child attributes