v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-031984301.2 MB
Vendor

Get Vendor

Retrieves a vendor by identifier.

Use the fields query parameter to include optional nested resources such as members. The members field returns the users in the vendor's VendorProjectManager group. To manage vendor members, use the Create User, Update User, or Update Group endpoints.

get/vendors/{vendorId}

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Authorizationstring required

The bearer access token provided by Auth0.

Response

idstring required

The unique identifier of the vendor. Generated by the system.

namestring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The name of the vendor.</div>
descriptionstring

A description of the vendor.

selfManagedboolean

Indicates whether the vendor is self-managed. When true, the vendor can manage its own users.