Vendors - Propify Documentation

{
  "meta": {
    "offset": "integer",
    "limit": "integer",
    "orderBy": [
      {}
    ],
    "hasMore": [
      "boolean",
      "null"
    ],
    "total": "number"
  },
  "results": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "x_gl_account_id": [
        "string",
        "null"
      ],
      "x_id": "string",
      "x_property_id": "string",
      "account_number": [
        "string",
        "null"
      ],
      "address_1": [
        "string",
        "null"
      ],
      "address_2": [
        "string",
        "null"
      ],
      "address_type_id": [
        "string",
        "null"
      ],
      "category_id": [
        "string",
        "null"
      ],
      "category": [
        "string",
        "null"
      ],
      "city": [
        "string",
        "null"
      ],
      "company_name": [
        "string",
        "null"
      ],
      "country": [
        "string",
        "null"
      ],
      "custom_data": {},
      "email_1": [
        "string",
        "null"
      ],
      "email_2": [
        "string",
        "null"
      ],
      "external_id": [
        "string",
        "null"
      ],
      "first_name": [
        "string",
        "null"
      ],
      "include_in_1099": [
        "boolean",
        "null"
      ],
      "insurance_expire_date": [
        "string",
        "null"
      ],
      "insurance_policy_number": [
        "string",
        "null"
      ],
      "insurance_provider": [
        "string",
        "null"
      ],
      "is_active": [
        "boolean",
        "null"
      ],
      "is_company": [
        "boolean",
        "null"
      ],
      "is_compliant": [
        "boolean",
        "null"
      ],
      "last_name": [
        "string",
        "null"
      ],
      "location_name": [
        "string",
        "null"
      ],
      "notes": [
        "string",
        "null"
      ],
      "payment_method": [
        "string",
        "null"
      ],
      "payment_type_id": [
        "string",
        "null"
      ],
      "payment_type": [
        "string",
        "null"
      ],
      "phone_1_type": "FAX",
      "phone_1": [
        "string",
        "null"
      ],
      "phone_2_type": "FAX",
      "phone_2": [
        "string",
        "null"
      ],
      "state": [
        "string",
        "null"
      ],
      "tax_address_1": [
        "string",
        "null"
      ],
      "tax_address_2": [
        "string",
        "null"
      ],
      "tax_city": [
        "string",
        "null"
      ],
      "tax_country": [
        "string",
        "null"
      ],
      "tax_payer_id": [
        "string",
        "null"
      ],
      "tax_payer_name_1": [
        "string",
        "null"
      ],
      "tax_payer_name_2": [
        "string",
        "null"
      ],
      "tax_payer_type": [
        "string",
        "null"
      ],
      "tax_state": [
        "string",
        "null"
      ],
      "tax_zip": [
        "string",
        "null"
      ],
      "website": [
        "string",
        "null"
      ],
      "zip": [
        "string",
        "null"
      ],
      "integration_id": "string",
      "integration_vendor": "string",
      "property_id": "string"
    }
  ]
}

Query Parameters

order-by

string

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=vendor:asc,created_at:desc

offset

Default: 0

integernull

Can be used for paginating results

limit

Default: 100

integernull

A number between 1 and 250 to determine the number of results to return in a single query

x_id

string

The external vendor id

x_property_id

string

The external property id

x_gl_account_id

string

The external GL account id

property_id

string

The Propify property id

integration_id

string

The Propify integration id

integration_vendor

string

The integration vendor for the applicant.

Response

metarequired

object

resultsrequired

array

idrequired

string

The Propify unique identifier for the vendor

created_atrequired

string

The date record first entered Propify

updated_atrequired

string

The date record was last updated in Propify

x_gl_account_idrequired

string | null

The external ID of the general ledger account from the integration vendor

x_idrequired

string

The external ID from the integration vendor

x_property_idrequired

string

The external ID of the property from the integration vendor

account_numberrequired

string | null

The account number of the vendor

address_1required

string | null

Vendor address line 1

address_2required

string | null

Vendor address line 2

address_type_idrequired

string | null

The unique identifier of the address type

category_idrequired

string | null

The unique identifier of the vendor category

categoryrequired

string | null

The vendor category

cityrequired

string | null

Vendor address city

company_namerequired

string | null

Company name of the vendor

countryrequired

string | null

Vendor address country

custom_datarequired

object | null

Custom data

email_1required

string | null

Primary email for the vendor

email_2required

string | null

Alternate email for the vendor

external_idrequired

string | null

The external id of the vendor

first_namerequired

string | null

First name of the vendor

include_in_1099required

boolean | null

If tax payer is required to file 1099 form

insurance_expire_daterequired

string | null

Vendor insurance policy expiration date

insurance_policy_numberrequired

string | null

Vendor insurance policy number

insurance_providerrequired

string | null

Vendor insurance provider

is_activerequired

boolean | null

Indicates whether the vendor is active

is_companyrequired

boolean | null

Indicates whether the vendor should be considered a company or person

is_compliantrequired

boolean | null

Indicates if the vendor is compliant

last_namerequired

string | null

Last name of the vendor

location_namerequired

string | null

The name of the vendor location

notesrequired

string | null

Notes about the vendor

payment_methodrequired

string | null

The payment method for the vendor

payment_type_idrequired

string | null

The unique identifier of the payment type for the vendor

payment_typerequired

string | null

The payment type for the vendor

phone_1_typerequired

string | null

Primary phone number type

Available options:

FAX,

HOME,

MOBILE,

OTHER,

WORK

phone_1required

string | null

Primary phone number for the vendor

phone_2_typerequired

string | null

Alternate phone number type

Available options:

FAX,

HOME,

MOBILE,

OTHER,

WORK

phone_2required

string | null

Alternate phone number for the vendor

staterequired

string | null

Vendor address state

tax_address_1required

string | null

The tax payer address line 1

tax_address_2required

string | null

The tax payer address line 2

tax_cityrequired

string | null

The tax payer address city

tax_countryrequired

string | null

The tax payer address country

tax_payer_idrequired

string | null

The unique identifier of the tax payer

tax_payer_name_1required

string | null

The tax payer name 1

tax_payer_name_2required

string | null

The tax payer name 2

tax_payer_typerequired

string | null

The tax payer type

tax_staterequired

string | null

The tax payer address state

tax_ziprequired

string | null

The tax payer address zip code

websiterequired

string | null

The website of the vendor

ziprequired

string | null

Vendor address zip code

integration_idrequired

string

The Propify unique identifier for the integration

integration_vendorrequired

string

The property management system of record

property_idrequired

string

The Propify unique identifier for the property

API Reference

​Query Parameters

​Response

Query Parameters

Response