Skip to main content
GET
List Vendors

Headers

Authorization
string
required

Bearer [access_token]

Response

Vendor list for the caller's team. Empty array when the team has no vendors.

id
integer<int64>

Internal vendor record ID, stable within the team. Distinct from the OAuth vendorId used for authentication.

Example:

11

agentUserId
integer<int64>

CRM user ID of the agent this vendor entry represents. 0 or null means the vendor is not linked to a CRM user account (e.g. external contractor-only entries).

Example:

100234

firstName
string

Given name of the vendor.

Example:

"Alice"

lastName
string

Family name of the vendor.

Example:

"Johnson"

phoneNumber
string

Phone number, local subscriber part only (without country or area prefix). Combine with phoneCode and phoneCountry to reconstruct the full E.164 number.

Example:

"5551234567"

phoneCode
string

Phone country calling code, digits only, no leading '+'.

Example:

"1"

phoneCountry
string

ISO 3166-1 alpha-2 country code of the phone number.

Example:

"US"

email
string

Primary email address of the vendor. May be empty when no email is on file.

Example:

"alice@example.com"

roleName
string

Human-readable role name of the vendor within the team (e.g. 'Agent', 'Admin', 'Lender', 'Transaction Coordinator'). Internal role codes are not exposed.

Example:

"Agent"

companyName
string

Company or brokerage name the vendor belongs to. May be empty.

Example:

"Lofty Realty"

companyAddress
string

Street address of the vendor's company, free-form single line. May be empty.

Example:

"500 Congress Ave, Austin, TX 78701"