Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Vendor

List Vendors

Returns the vendor directory for the team .Notes:

  • Scope: the list is scoped to the caller's team (teamId is resolved from the token).
  • Ordering is not guaranteed; do not rely on a specific sort order.
  • Only the fields defined in VendorInfo are exposed; internal fields are not returned.
  • The response is a bare JSON array; empty array when the team has no vendors.
get/v1.0/vendor/list

Headers

Authorizationstring required

Bearer [access_token]

Response

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

idinteger

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

agentUserIdinteger

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).

firstNamestring

Given name of the vendor.

lastNamestring

Family name of the vendor.

phoneNumberstring

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

phoneCodestring

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

phoneCountrystring

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

emailstring

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

roleNamestring

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

companyNamestring

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

companyAddressstring

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

Example response

[
  {
    "id": 11,
    "agentUserId": 100234,
    "firstName": "Alice",
    "lastName": "Johnson",
    "phoneNumber": "5551234567",
    "phoneCode": "1",
    "phoneCountry": "US",
    "email": "alice@example.com",
    "roleName": "Agent",
    "companyName": "Lofty Realty",
    "companyAddress": "500 Congress Ave, Austin, TX 78701"
  }
]