Vendors

List vendors

Lists your organization's vendors, newest first, cursor-paginated. custom_id filters by exact match on your identifier for the vendor. name matches fuzzily — a case-insensitive substring hit or a close-but-inexact spelling both match, so "acme" and "Acmee Contsruction" each find "ACME Construction LLC". Results keep the newest-first order rather than ranking by match quality. project_id narrows to vendors linked to a project your service account can access — through agreements, invoices, lien waivers, documents, funding sources, draws, or stakeholders. An unknown or inaccessible filter value yields an empty list.

get/vendors

Request

  • Base URL: https://api.rabbet.com/v1
  • URL: https://api.rabbet.com/v1/vendors
  • Auth: OAuth 2 (client credentials, token URL https://api.rabbet.com/oauth/token, scopes: read)

Query parameters

custom_idstring

Your identifier for the vendor, as stored on it. Must not be empty when provided. Not guaranteed unique, so more than one vendor may match.

namestring

Fuzzy name filter, at least two characters.

project_idstring uuid

Only vendors linked to this project. The project must be accessible to your service account; an inaccessible or unknown project yields an empty list.

limitinteger

Page size, between 1 and 100.

cursorstring

Opaque cursor from the previous page's pagination.next_cursor.

Response

A page of vendors (empty when none match).

Example response

{
  "data": [
    {
      "id": "b7b36587-1c9f-4e2c-a5b0-6f0a4b2f9e11",
      "name": "ACME Construction LLC",
      "type": "contractor",
      "custom_id": "V-00042",
      "email_addresses": [
        "ap@acmeconstruction.com"
      ],
      "phone_numbers": [
        "512-555-0142"
      ],
      "street_address": "100 Congress Ave",
      "city": "Austin",
      "state": "tx",
      "zip": "78701"
    }
  ],
  "pagination": {
    "next_cursor": "g3QAAAACdwJpZG0AAAAkZDI5MGYxZWU"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.