v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Vendors
Fields

Vendor Suggested Fields

This request gets all possible fields a Vendor can pick from when deciding which fields it should have.

get/v2/vendors/fields/suggested

Query parameters

fieldsstring

This parameter can be used to get a single Vendor Fields or a list of Vendor Fields in a comma-separated list.

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

cursorinteger

This parameter is a cursor that selects what fieldID you want to start receiving results at. e.g. passing 137 here will only get you vendor fields with an id greater than 137.

limitinteger

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

Response

Vendor Suggested Fields

fieldIDinteger
fieldTypestring
fieldNamestring
locationIDinteger