Get all vendors

Returns all vendors for the authenticated organization. Supports both API key authentication (X-API-Key header) and session authentication (cookies + X-Organization-Id header).

GET /v1/vendors

Try it

Get all vendors

cURL

curl --request GET \
  --url http://localhost:3333/v1/vendors \
  --header 'X-API-Key: <api-key>'

200

{
  "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,
  "authType": "api-key",
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "[e-mail]"
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Headers

X-Organization-Id · string

Organization ID (required for session auth, optional for API key auth)

Response

200

application/json

Vendors retrieved successfully

data · object[]

Show child attributes

data. id · string

Vendor ID

Example:

"vnd_abc123def456"

data. name · string

Vendor name

Example:

"CloudTech Solutions Inc."

data. description · string

Vendor description

Example:

"Cloud infrastructure provider offering AWS-like services"

data. category · enum<string>

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

Example:

"cloud"

data. status · enum<string>

Available options: not_assessed, in_progress, assessed

Example:

"not_assessed"

data. inherentProbability · enum<string>

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

Example:

"possible"

data. inherentImpact · enum<string>

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

Example:

"moderate"

data. residualProbability · enum<string>

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

Example:

"unlikely"

data. residualImpact · enum<string>

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

Example:

"minor"

data. website · string | null

Example:

"https://www.cloudtechsolutions.com"

data. assigneeId · string | null

ID of the user assigned to manage this vendor

Example:

"mem_abc123def456"

data. createdAt · string<date-time>

When the vendor was created

data. updatedAt · string<date-time>

When the vendor was last updated

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)

Show child attributes

authenticatedUser. id · string

Example:

"usr_def456ghi789"

authenticatedUser. email · string

Example:

"[e-mail]"