Skip to main content
GET
/
v2
/
vendors
/
{vendorId}
/
profile
Get Vendor Profile
curl --request GET \
  --url https://api.puppetvendors.com/v2/vendors/{vendorId}/profile \
  --header 'x-access-token: <api-key>'
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Retrieve the custom profile fields for a specific vendor. Profile fields are merchant-defined key-value pairs that store additional vendor information such as company registration numbers, tax IDs, or website URLs.

​
Use Cases

  • Vendor detail pages — Display custom profile information in dashboards
  • Compliance checks — Retrieve vendor registration or tax details
  • Data export — Pull vendor profile data into external systems

​
Path Parameters

​
vendorId
string
required
The vendor’s MongoDB ObjectId.

​
Response

200
{
  "success": true,
  "data": {
    "profile": {
      "fields": [
        { "field": "Company Registration", "value": "12345678" },
        { "field": "Website", "value": "https://acmesupplies.com" },
        { "field": "Tax ID", "value": "GB123456789" }
      ]
    }
  }
}

​
Error Response

404
{
  "success": false,
  "error": {
    "message": "Vendor not found",
    "code": "NOT_FOUND"
  }
}

​
Example

curl -X GET https://api.puppetvendors.com/v2/vendors/507f1f77bcf86cd799439011/profile \
  -H "x-access-token: YOUR_JWT_TOKEN"