Routes
Vendors
Logs

This request returns the manual log entries for a vendor.

This request returns logs created manually by users on vendors. Logs related to tasks with vendors will not be returned.

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

Return data description

PropertyDescription
logIDThe unique logID of the log.
dateCreatedThe date the log was created as a UNIX timestamp.
vendorIDThe ID of the vendor the log belongs to.
logEntryThe log entry for the vendor.
userIDThe ID of the user that created the log.
logFilesAn array of objects that have a fileID, fileName and a link that can used to download the files attached to the log. All links are only valid for 15 minutes, a new call will generate a new link.
get/v2/vendors/{vendorID}/logs

Request

Query parameters

logsstring

This parameter is used to only get specific logs. This parameter accepts a comma delimited list of logIDs.

usersinteger

This parameter is used to only get logs created by specific users. This parameter accepts a comma delimited list of userIDs.

logEntrystring

This is a parameter used to string search for manual log entry. This parameter expects a string with the wildcard %.

startinteger

This parameter is used to only get logs that were last edited after the unix timestamp passed into the start parameter.

endinteger

This parameter is used to only get logs that were last edited before the unix timestamp passed into the end parameter.

pageinteger

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

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.

cursorstring

This parameter is a cursor that selects what ID you want to start receiving results at.

Response

Vendor Logs

logIDinteger
dateCreatedinteger
logEntrystring
userIDinteger

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