GET
/
v1
/
businesses
/
{businessId}
/
vendors
List vendors
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/vendors \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "individual_name": "<string>",
    "company_name": "<string>",
    "email": "<string>",
    "mobile_phone": "<string>",
    "office_phone": "<string>",
    "address_string": "<string>",
    "memo": "<string>",
    "status": "ACTIVE",
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business to fetch vendors for

Query Parameters

​
include_archived
boolean
default:false

Whether to include archived vendors in the response

​
external_id
string

The external ID of the vendor to fetch

​
external_id_contains
string

A case-insensitive substring used to filter vendors whose external ID contains the specified value.

​
name
string

The name of the vendors to fetch

​
name_contains
string

A case-insensitive substring used to filter vendors whose name contains the specified value.

​
reference_numbers
string

Comma-separated list of reference numbers to filter vendors by. Only vendors with reference numbers matching any value in this list will be returned.

Response

200 - application/json

Success

​
id
string<uuid>

Unique identifier for the vendor.

​
external_id
string

Unique ID of the vendor in your system for linking purposes. Idempotency key.

​
individual_name
string | null

Full name of the individual vendor or contact at a corporate vendor.

​
company_name
string | null

Name of the company vendor.

​
email
string | null

Email address of the vendor.

​
mobile_phone
string | null

Mobile phone number of the vendor.

​
office_phone
string | null

Office phone number of the vendor.

​
address_string
string | null

Address of the vendor.

​
memo
string | null

Memo for any text you would like to associate with the vendor (for example, to display to end users).

​
status
enum<string>

Status of the vendor.

Available options:
ACTIVE,
ARCHIVED
​
transaction_tags
object[]