> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://beta-docs.payabli.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # List vendors by organization GET https://api-sandbox.payabli.com/api/Query/vendors/org/{orgId} Retrieve a list of vendors for an organization. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/vendor/get-list-of-vendors-for-organization ## Authentication - `requestToken` header (required) — API Key authentication via header ## Servers - `https://api-sandbox.payabli.com/api` (Sandbox, default) - `https://api.payabli.com/api` (Production) ## Request ### Path parameters - `orgId` (integer, required) — The numeric identifier for organization, assigned by Payabli. ### Query parameters - `fromRecord` (integer, optional, default: 0) — The number of records to skip before starting to collect the result set. - `limitRecord` (integer, optional, default: 20) — Max number of records to return for the query. Use `0` or negative value to return all records. - `parameters` (map from string to string, optional) — Collection of field names, conditions, and values used to filter the query **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.** Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client. For example: \--url [https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000\&limitRecord=20](https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount\(gt\)=1000\&limitRecord=20) should become: \--url [https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000\&limitRecord=20](https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount\(gt\)=1000\&limitRecord=20) See [Filters and Conditions Reference](/developer-guides/reporting-filters-and-conditions-reference) for help. List of field names accepted: * method (in, nin, eq, ne) * enrollmentStatus (in,nin, eq, ne) * status (in, nin, eq, ne) * vendorNumber (ct, nct, eq, ne) * name (ct, nct, eq, ne) * ein (ct, nct, eq, ne) * phone (ct, nct, eq, ne) * email (ct, nct, eq, ne) * address (ct, nct, eq, ne) * city (ct, nct, eq, ne) * state (ct, nct, eq, ne) * country (ct, nct, eq, ne) * zip (ct, nct, eq, ne) * mcc (ct, nct, eq, ne) * locationCode (ct, nct, eq, ne) * paypointLegal (ne, eq, ct, nct) * paypointDba (ne, eq, ct, nct) * parentOrgId (ne, eq, nin, in) * orgName (ne, eq, ct, nct) List of comparison accepted - enclosed between parentheses: * eq or empty => equal * gt => greater than * ge => greater or equal * lt => less than * le => less or equal * ne => not equal * ct => contains * nct => not contains * in => inside array separated by "|" * nin => not inside array separated by "|" List of parameters accepted: * limitRecord : max number of records for query (default="20", "0" or negative value for all) * fromRecord : initial record in query Example: netAmount(gt)=20 return all records with netAmount greater than 20.00 - `sortBy` (string, optional) — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. ## Response ### 200 Success - `Records` (list of VendorQueryRecord, optional) - `Summary` (QuerySummary, optional) ## Errors ### 400 Bad Request Error Bad request/ invalid data - `any` ### 401 Unauthorized Error Unauthorized request. - `any` ### 500 Internal Server Error Internal API Error - `any` ### 503 Service Unavailable Error Database connection error - `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure. - `responseData` (map from string to any, optional) — The object containing the response data. - `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'. ## Types ### VendorQueryRecord - `additionalData` (map from string to map from string to any, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developer-guides/entities-custom-identifiers), pass those in this object. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `address1` (string, optional) — Vendor's address. - `address2` (string, optional) — Additional line for vendor's address. - `billingData` (BillingDataResponse, optional) - `city` (string, optional) — Vendor's city. - `contacts` (list of Contacts, optional) — List of contacts. - `country` (string, optional) — Vendor's country. - `createdDate` (datetime, optional) — Timestamp of when record was created, in UTC. - `customerVendorAccount` (string, optional) — Account number of paypoint in the vendor system. - `ein` (string, optional) — Business EIN or tax ID. This value is masked in API responses, for example `XXXX6789`. - `email` (string, optional) — Vendor's email address. - `enrollmentStatus` (string, optional) — Enrollment status of vendor in payables program. - `externalPaypointId` (string, optional) — A custom identifier for the paypoint, if applicable. Like `entrypoint` is the Payabli identifier for the merchant, `externalPaypointId` is a custom field you can use to include the merchant's ID from your own systems. - `internalReferenceId` (long, optional) — Internal identifier for global vendor account. - `lastUpdated` (datetime, optional) — Timestamp of when record was last updated, in UTC. - `locationCode` (string, optional) — Additional location code used to identify the vendor. - `mcc` (string, optional) — Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv) lists MCC codes. - `name1` (string, optional) — Primary name for vendor. - `name2` (string, optional) — Secondary name for vendor. - `parentOrgName` (string, optional) — The name of the parent organization. - `payeeName1` (string, optional) — Alternative name used to receive paper check. - `payeeName2` (string, optional) — Alternative name used to receive paper check. - `paymentMethod` (VendorPaymentMethod, optional) — Object containing details about the payment method to use for the payout. - `paypointDbaname` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name. - `paypointEntryname` (string, optional) — The entrypoint identifier. - `paypointLegalname` (string, optional) — Business legal name. - `phone` (string, optional) — Vendor's phone number. - `remitAddress1` (string, optional) — Remittance address. Used for mailing paper checks. - `remitAddress2` (string, optional) — Remittance address additional line. Used for mailing paper checks. - `remitCity` (string, optional) — Remittance address city. Used for mailing paper checks. - `remitCountry` (string, optional) — Remittance address country. Used for mailing paper checks. - `remitState` (string, optional) — Remittance address state. Used for mailing paper checks. - `remitZip` (string, optional) — Remittance address ZIP code. Used for mailing paper checks. - `state` (string, optional) — Vendor's state. - `summary` (VendorSummary, optional) - `vendorId` (integer, optional) — Payabli identifier for vendor record. - `vendorNumber` (string, optional) — Custom number identifying the vendor. Must be unique in paypoint. - `vendorStatus` (integer, optional) — Vendor's status. Allowed status: - 0 Inactive - 1 Active - `zip` (string, optional) — Vendor's zip code. ### QuerySummary - `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `pageSize` (integer, optional) — Number of records on each response page. - `totalAmount` (double, optional) — Total amount for the records. - `totalNetAmount` (double, optional) — Total net amount for the records. - `totalPages` (integer, optional) — Total number of records in response. - `totalRecords` (integer, optional) — Total number of records in response. ### BillingDataResponse - `accountNumber` (string, optional) — Masked account number for bank account. - `bankAccountFunction` (integer, optional) — Describes whether the bank account is used for deposits or withdrawals in Payabli: - `0`: Deposit - `1`: Withdrawal - `2`: Deposit and withdrawal - `bankAccountHolderName` (string, optional) — The accountholder's name. - `bankAccountHolderType` (enum, optional) — Describes whether the bank is a personal or business account. - Allowed values: `Personal`, `Business` - `bankName` (string, optional) — Name of bank for account. - `id` (integer, optional) — The bank's ID in Payabli. - `routingAccount` (string, optional) — Routing number of bank account. - `typeAccount` (enum, optional) — Type of bank account: Checking or Savings. - Allowed values: `Checking`, `Savings` ### Contacts - `contactEmail` (string, optional) — Contact email address. - `contactName` (string, optional) — Contact name. - `contactPhone` (string, optional) — Contact phone number. - `contactTitle` (string, optional) — Contact title. ### VendorPaymentMethod Object containing details about the payment method to use for the payout. - `method` (enum, optional) — Payment method to use for payout. Leave empty for managed payables. - Allowed values: `managed`, `vcard`, `ach`, `check` ### VendorSummary - `inTransitBills` (integer, optional) - `inTransitBillsAmount` (double, optional) - `overdueBills` (integer, optional) - `overdueBillsAmount` (double, optional) - `paidBills` (integer, optional) - `paidBillsAmount` (double, optional) - `pendingBills` (integer, optional) - `pendingBillsAmount` (double, optional) - `totalBills` (integer, optional) - `totalBillsAmount` (double, optional) ## Examples **Response** ```json { "Records": [ { "additionalData": { "key1": { "key": "value" }, "key2": { "key": "value" }, "key3": { "key": "value" } }, "address1": "123 Ocean Drive", "address2": "Suite 400", "billingData": { "bankAccountFunction": 0, "bankAccountHolderName": "Gruzya Adventure Outfitters LLC" }, "city": "Bristol", "contacts": [ {} ], "country": "US", "createdDate": "2022-07-01T15:00:01Z", "customerVendorAccount": "123-456", "ein": "123456789", "email": "example@email.com", "enrollmentStatus": "enrollmentStatus", "externalPaypointId": "Paypoint-100", "internalReferenceId": 1000000, "lastUpdated": "2022-07-01T15:00:01Z", "locationCode": "LOC123", "mcc": "7777", "name1": "Herman's Coatings", "name2": "Herman's Coating Supply Company, LLC", "parentOrgName": "PropertyManager Pro", "payeeName1": "payeeName1", "payeeName2": "payeeName2", "paypointDbaname": "Sunshine Gutters", "paypointEntryname": "d193cf9a46", "paypointLegalname": "Sunshine Services, LLC", "phone": "212-555-1234", "remitAddress1": "123 Walnut Street", "remitAddress2": "Suite 900", "remitCity": "Miami", "remitCountry": "US", "remitState": "FL", "remitZip": "31113", "state": "GA", "vendorId": 1, "vendorNumber": "1234", "vendorStatus": 1, "zip": "31113" } ], "Summary": { "pageIdentifier": "null", "pageSize": 20, "totalAmount": 200, "totalNetAmount": 77.22, "totalPages": 1, "totalRecords": 1 } } ``` **SDK Code** ```python An example response for vendor queries import requests url = "https://api-sandbox.payabli.com/api/Query/vendors/org/123" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript An example response for vendor queries const url = 'https://api-sandbox.payabli.com/api/Query/vendors/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29'; const options = {method: 'GET', headers: {requestToken: ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go An example response for vendor queries package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/vendors/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("requestToken", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby An example response for vendor queries require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/vendors/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java An example response for vendor queries import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/vendors/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php An example response for vendor queries request('GET', 'https://api-sandbox.payabli.com/api/Query/vendors/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp An example response for vendor queries using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/vendors/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29"); var request = new RestRequest(Method.GET); request.AddHeader("requestToken", ""); IRestResponse response = client.Execute(request); ``` ```swift An example response for vendor queries import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/vendors/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```