Fishbowl Advanced REST API Documentation

Vendor

This is an object representing a Fishbowl vendor.

Related guide: Vendor

ENDPOINTS

GET /api/vendors

Search for vendors

Searches for vendors.

Parameters

pageNumber integer

The current page of the results.

pageSize integer

The number of returned results per page. (Default 100)

name string

The vendor name.

accountNumber string

The vendor account number.

city string

The vendor address city.

state string

The vendor address state.

country string

The vendor address country

active boolean

Indicates if the vendor is active.

Attributes

customFields list

A list of the vendor's custom fields.

GET /api/vendors

curl --location \
--request GET '<YOUR SERVER>/api/vendors' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>'

RESPONSE

{
  "totalCount": 3,
  "totalPages": 1,
  "pageNumber": 1,
  "pageSize": 100,
  "results": [
    {
      "id": 16,
      "name": "Mike's Bikes",
      "accountNumber": "216489",
      "active": true
    },
    {
      "id": 24,
      "name": "Monroe Bike Company",
      "accountNumber": "5976",
      "active": true
    },
    {
      "id": 21,
      "name": "Rocky Mountain Bikes",
      "accountNumber": "98979",
      "active": true
    }
  ]
}