Supported operations
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/vendors | List all vendors |
| GET | /api/v1/vendors/:id | Get a vendor by ID |
| POST | /api/v1/vendors | Create a new vendor |
| PATCH | /api/v1/vendors/:id | Update a vendor |
| DELETE | /api/v1/vendors/:id | Delete a vendor |
Example request
Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.
curl --request GET "/api/v1/vendors" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"Field reference
Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.
| Field | Type | Model requirement | Description |
|---|---|---|---|
id | string | Optional | Unique identifier (auto-generated) |
name | string | Required | name |
category | string | Optional | category |
contactName | string | Optional | contact Name |
contactEmail | string | Optional | contact Email |
contactPhone | string | Optional | contact Phone |
address | string | Optional | address |
city | string | Optional | city |
state | string | Optional | state |
zipCode | string | Optional | zip Code |
website | string | Optional | website |
notes | string | Optional | notes |
status | enum | Optional | status Values: |
createdAt | datetime | Optional | Creation timestamp (auto) |
updatedAt | datetime | Optional | Last update timestamp (auto) |