Skip to navigation
Dice Standardized APIs V2 CopyVendor

Fetch Vendors API

View as Markdown

Fetch Vendors API

This API is to get all Vendors existing in Dice.

ParamsRequiredDescription
start_dateMandatoryDate filter, from which date the vendor needs to be fetched.

Format - dd-MM-yyyy
end_dateMandatoryDate filter, till which date the vendor need to be fetched.

Format - dd-MM-yyyy
offsetMandatoryPage Number
pageSizeOptionalNumber of vendor to be fetched in a single page. Value cannot be greater than 5000.

If not provided along with the request then default value will be 1000 considered.

Headers

DICE-APP-IDstringOptional
Company Code of client
X-CLIENT-IDstringOptional
API Client ID
X-CLIENT-SECRETstringOptional
API Client Secret

Query parameters

start_datestringOptional

Date should be in dd-MM-yyyy format and it runs on CreatedAt

end_datestringOptional

Date should be in dd-MM-yyyy format and it runs on CreatedAt

offsetintegerOptional

Offset starts from 0 (Page Number), values can be 0, 1, 2

pageSizeintegerOptional
optinal parameter, default is 1000

Response

OK
vendorslist of any
totalinteger
currentPageinteger
totalPagesinteger