Skip to main content
This reference lists the main objects in the VendexLabs data model and their most important fields. Field availability can depend on your role and on whether a vendor has been fully enriched.

Account

The organization that owns lists, assessments, and members.
FieldTypeNotes
iduuid
namestringUnique
activeboolean
plan_tierstringe.g. community
vendor_limitintegerTracked-vendor cap for the plan
assessment_expiry_alert_lead_daysintegerDays before expiry to start reminding
internal_email_domainsstring[]Domains treated as internal

User & membership

ObjectFieldNotes
Userid, email, name, onboardedGlobal user
AccountUseraccount, user, roleRole: owner | admin | member | viewer

Vendor & profile

ObjectFieldNotes
Vendorid, name, website_urlGlobal directory entry
VendorProductid, vendor, name, sourcesource: enriched | custom
VendorProfileid, vendor, industry, company_description, founded_year, employee_countEnriched dossier
VendorProfilesecurity_rating, risk_score, risk_categories, breach_historyScores; security_rating higher is better, risk_score = 100 − adjusted
VendorProfiledata_collected, website_url, headquarters_location

GRC assessment (scoring)

VendorGrcAssessment — a scoring snapshot.
FieldTypeNotes
assessed_atdatetime
vendor_categorystringCategory used for scoring
integration_depthstringDEEP | MODERATE | LIGHT
raw_scoreintegerAggregate (sum of domain points)
adjusted_scoreintegerAfter integration-depth adjustment
risk_tierstringe.g. Low
recommendationstringApprove | Conditional | Do Not Approve
floor_rules_triggeredarrayGuardrail rules that fired

Vendor list & membership

ObjectFieldNotes
VendorListid, name, accountmaster-list by default
VendorListVendorvendor_list, vendor, vendor_productMembership
VendorListVendoralerts_enabled, dependency_tierTier drives portfolio weighting

Assessment

VendorAssessment — your review record.
FieldTypeNotes
compliance_approval_statusenumnot-started, in-progress, on-hold, approved, conditional approval, rejected
conditional_approval_conditionstringFor conditional approvals
sponsor_business_departmentstring
sponsor_contactstring
notify_sponsor_on_updateboolean
security_commentstring
compliance_commentstring
compliance_contactstring
submission_datedate
approval_datedate
data_collectedstring[]Data categories
use_casestring
Related objects: VendorAssessmentDocument (evidence: name, document_type, s3_key, file_size, expiration_date) and VendorAssessmentLogs (audit entries: field, old_value, new_value, submitted_by, event_id).

History snapshots

ObjectPurpose
VendorProfileGrcMonthlyFrozen monthly aggregate per vendor (year_month, raw_score)
VendorListPostureMonthlyMonthly tier-weighted list posture (overall_posture)
This is a working reference, not an exhaustive schema. Field names follow the objects returned by the API; see the endpoint pages for request/response specifics.