GET
/
coa
/
api
/
vendor
List Vendors
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/vendor \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 123,
      "contacts": [
        {
          "id": 123,
          "name": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "jsmith@example.com",
          "phone_number": "<string>",
          "mobile_number": "<string>"
        }
      ],
      "parent_name": "<string>",
      "stripe_connection_name": "<string>",
      "stripe_connection_entity": 123,
      "stripe_connection_portal_url": "<string>",
      "stripe_connection_portal_enabled": true,
      "vendor_custom_field_1_name": "<string>",
      "search_vector": "<string>",
      "search_text": "<string>",
      "vendor_type": "vendor",
      "name": "<string>",
      "company_name": "<string>",
      "website": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "phone_number": "<string>",
      "mobile_number": "<string>",
      "address_street_1": "<string>",
      "address_street_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>",
      "country": "<string>",
      "notes": "<string>",
      "business_id_ssn": "<string>",
      "is_1099": true,
      "vat_number": "<string>",
      "stripe_customer_id": "<string>",
      "use_stripe_auto_bill": true,
      "external_id": "<string>",
      "bill_vendor_id": "<string>",
      "source": "BILL",
      "invoice_message": "<string>",
      "abbreviation": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "customer": 123,
      "parent": 123,
      "stripe_connection": 123,
      "default_expense_category": 123,
      "vendor_custom_field_1": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
external_id
string

Filter by external ID

​
include_inactive
boolean
default:false

Include inactive vendors in results

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
q
string

Search query - searches by name, email, or company name. If numeric, searches by ID

​
sort
string
default:name

Sort order. Use field name for ascending, -field for descending. Supports multiple fields separated by comma. Default: name

​
vendor_type
enum<string>

Filter by vendor type. Can be specified multiple times for multiple types

Available options:
customer,
vendor

Response

200 - application/json

The response is of type object.