vendors.list
List the shop's suppliers (archived ones only with include_archived). Owner or office.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/vendors |
| MCP tool | vendors_list |
| Writes | no |
| Area | Shop |
When to use it
List the shop's suppliers (archived ones only with include_archived). Owner or office.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
include_archived | boolean | no |
Example
GET https://doingwork.work/v1/vendors?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
data | array | yes |
data[].vendor_id | string (uuid) | yes |
data[].shop_id | string (uuid) | yes |
data[].name | string | yes |
data[].email | ['string', 'null'] | yes |
data[].phone | ['string', 'null'] | yes |
data[].account_number | ['string', 'null'] | yes |
data[].note | ['string', 'null'] | yes |
data[].archived | boolean | yes |
{
"data": [
{
"vendor_id": "00000000-0000-4000-8000-000000000000",
"shop_id": "00000000-0000-4000-8000-000000000000",
"name": "Ruiz Plumbing",
"email": "owner@example.com",
"phone": "...",
"account_number": "...",
"note": "...",
"archived": true
}
]
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |