vendors.list

List the shop's suppliers (archived ones only with include_archived). Owner or office.

WhoAgents can call this
RESTGET /v1/vendors
MCP toolvendors_list
Writesno
AreaShop

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.

Input

FieldTypeRequired
shop_idstring (uuid)yes
include_archivedbooleanno

Example

GET https://doingwork.work/v1/vendors?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
dataarrayyes
data[].vendor_idstring (uuid)yes
data[].shop_idstring (uuid)yes
data[].namestringyes
data[].email['string', 'null']yes
data[].phone['string', 'null']yes
data[].account_number['string', 'null']yes
data[].note['string', 'null']yes
data[].archivedbooleanyes
{
  "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

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.