Skip to main content
GET
/
v1
/
shop
/
profile
Get Vendor Profile Fields
curl --request GET \
  --url https://api.puppetvendors.com/v1/shop/profile \
  --header 'x-access-token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Returns the list of custom profile field names available for vendor profiles in your shop. These are the field names accepted by the Update Vendor Profile endpoint.

​
Use Cases

  • Discover available fields before reading or writing vendor profiles
  • Build dynamic forms that adapt to the profile configuration
  • Validate vendor data against the expected field list before submission

​
Response

200
{
  "fields": [
    "companyName",
    "taxId",
    "phone",
    "website",
    "description"
  ]
}

​
No Profile Configured

401
{
  "error": "Shop profile is not set."
}

​
Example

curl -X GET https://api.puppetvendors.com/v1/shop/profile \
  -H "x-access-token: YOUR_JWT_TOKEN"