GET
/
v1
/
vendor
/
list
curl --location --request GET 'https://api.stateset.com/v1/vendor' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'
{
  "success": 1,
  "new_user_group": true,
  "user_group": {
    "team_id": 3,
    "token": "<user_group_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

Body

limit
string
required

This is the limit of the vendors.

offset
string
required

This is the offset of the vendors.

order_direction
string
required

This is the order direction of the vendors.

Response

id
number

This is the id of the vendor.

vendorName
string

This is the name of the vendor.

vendorNotes
string

This is the notes of the vendor.

vendorSubtype
string

This is the subtype of the vendor.

vendorType
string

This is the type of the vendor.

vendor_owner
string

This is the owner of the vendor.

vendor_source
string

This is the source of the vendor.

annualRevenue
string

This is the annual revenue of the vendor.

avatar
string

This is the avatar of the vendor.

billingCity
string

This is the billing city of the vendor.

billingCountry
string

This is the billing country of the vendor.

billingLatitude
string

This is the billing latitude of the vendor.

billingLongitude
string

This is the billing longitude of the vendor.

billingState
string

This is the billing state of the vendor.

billingStreet
string

This is the billing street of the vendor.

created_at
string

This is the created at of the vendor.

description
string

This is the description of the vendor.

employees
string

This is the employees of the vendor.

fax
string

This is the fax of the vendor.

industry
string

This is the industry of the vendor.

is_active
string

This is the is active of the vendor.

is_public
string

This is the is public of the vendor.

last_modified_by
string

This is the last modified by of the vendor.

Vendors

Vendors describes the general data about the vendor in Stateset.

The vendor object

Attributes

NameTypeDescription
idTextUnique identifier for the vendor
vendorNameTextName of the vendor
vendorNotesTextNotes or additional information about the vendor
vendorSubtypeTextSubtype or specific category of the vendor
vendorTypeTextType or general category of the vendor
vendor_ownerTextOwner or responsible person for the vendor
vendor_sourceTextSource or origin of the vendor
annualRevenueTextAnnual revenue associated with the vendor
avatarTextURL or path to the vendor’s avatar image
billingCityTextCity of the billing address
billingCountryTextCountry of the billing address
billingLatitudeTextLatitude coordinate of the billing address
billingLongitudeTextLongitude coordinate of the billing address
billingStateTextState or province of the billing address
billingStreetTextStreet address of the billing address
created_atDate/TimeDate and time when the vendor was created
descriptionTextDescription or additional details about the vendor
employeesTextNumber or range of employees associated with the vendor
faxTextFax number of the vendor
industryTextIndustry or sector of the vendor
is_activeBooleanIndicates whether the vendor is currently active
is_publicBooleanIndicates whether the vendor is public or private
last_modified_byTextLast person who modified the vendor
numberOfEmployeesTextNumber of employees associated with the vendor
ownershipTextOwnership type or structure of the vendor
parentVendorTextParent vendor associated with the vendor
phoneTextPhone number of the vendor
ratingTextRating or evaluation of the vendor
shippingCityTextCity of the shipping address
shippingCountryTextCountry of the shipping address
shippingLatitudeTextLatitude coordinate of the shipping address
shippingLongitudeTextLongitude coordinate of the shipping address
shippingStateTextState or province of the shipping address
shippingStreetTextStreet address of the shipping address
stockTickerTextStock ticker symbol associated with the vendor
websiteTextWebsite URL of the vendor
yearStartedTextYear the vendor started or established