Skip to main content
GET
/
v1
/
vendors
List vendors
curl --request GET \
  --url https://api.trycomp.ai/v1/vendors \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "vnd_abc123def456",
      "name": "CloudTech Solutions Inc.",
      "description": "Cloud infrastructure provider offering AWS-like services",
      "category": "cloud",
      "status": "not_assessed",
      "inherentProbability": "possible",
      "inherentImpact": "moderate",
      "residualProbability": "unlikely",
      "residualImpact": "minor",
      "website": "https://www.cloudtechsolutions.com",
      "assigneeId": "mem_abc123def456",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 12,
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "user@example.com"
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Response

Vendors retrieved successfully

​
data
object[]
​
count
number

Total number of vendors

Example:

12

​
authType
enum<string>

How the request was authenticated

Available options:
api-key,
session
​
authenticatedUser
object

User information (only for session auth)