Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

/public/v1/inventory/vendors

  • Published on Jun 17, 2026
  • 2 minute(s) read
Prev Next
Get
/public/v1/inventory/vendors

Retrieves a list of vendors

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
modifiedOnStart
string (date-time)

Starting datetime of 'modifiedOn' range; must be accompanied by 'modifiedOnEnd'

modifiedOnEnd
string (date-time)

Ending datetime of 'modifiedOn' range; must be accompanied by 'modifiedOnStart'

pageSize
integer (int32)

Maximum number of top level objects in the response, max value 250; if there are more objects matching the criteria, a link with a continuation token will be included in the response

Responses
200

The list of vendors

Expand All
object
items
Array of object (VendorPublicDto) | null

Collection of query continuation response vendor records returned in this page.

object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddressPublicDto)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null
nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

Expand All
object
items
Array of object (VendorPublicDto) | null

Collection of query continuation response vendor records returned in this page.

object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddressPublicDto)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null
nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

Expand All
object
items
Array of object (VendorPublicDto) | null

Collection of query continuation response vendor records returned in this page.

object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (Users.UserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddressPublicDto)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null
nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.