LIlimblecmms
Routes
Vendors
Fields

Vendor Fields

Changed on

This request gets detailed information about Vendor Fields such as contact information, contracts and any other custom set field.

This request will return an array of objects that have a file name and a link you can use to download that image. All links are only valid for 15 minutes, a new call will generate a new link.

Note: this endpoint supports pagination. Please refer to the Pagination section for more information.

get/v2/vendors/fields

Request

Query parameters

fieldsstring

This parameter is used to only get specific fields by ID. This parameter expects a comma delimited list of fieldIDs.

namestring

This parameter is used to only get specific field by name. This parameter expects a string full name of a field or partial name with the wildcard %.

vendorsinteger

This parameter is used to only get specific Vendors. This parameter expects a comma delimited list of Vendor IDs.

startinteger

This parameter is used to only get vendor fields for vendors that were last edited after the unix timestamp passed into the start parameter. For example, all Vendors that were last edited after April 18th, 2018.

endinteger

This parameter is used to only get vendor fields for vendors that were last edited before the unix timestamp passed into the end parameter.

cursorinteger

This parameter is a cursor that selects what valueID you want to start receiving results at. e.g. passing 137 here will only get you vendor field values with a valueID greater than 137. Results are ordered by valueID ascending.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time. Maximum allowed value is 1000.

valueinteger

This parameter is used to only get specific field by value. This parameter expects a string full name of a field or partial name with the wildcard %.

pageinteger

This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.

valuesstring

This parameter is used to get vendor fields by their valueID. This parameter expects a comma delimited list of Value IDs.

Response

Vendor Fields

fieldIDinteger
vendorIDinteger
fieldNamestring
valueunknown
valueIDinteger
fieldTypestring
lastEditedinteger
locationIDinteger

Changes

  • 488d795f846fRevision changes
    • warning

      for the query request parameter limit, the max was set to 1000.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      added the non-success response with the status