Skip to main content
GET
Get HsVendor

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
number
required

The ID of the entity for this request.

Example:

5

Query Parameters

return
string

Comma-separated list of specific fields to return/append in the response. See isAdditionalData for more details.

Example:

"id,nameFirst,nameLast"

isAdditionalData
boolean

Set to true to merge requested fields with default response, or false/omit to return only requested fields plus ID.

Example:

true

Response

200 - application/json

HsVendor

ftrcTile
string
required

Represents the feature tile associated with a specific home service vendor.

id
number
required

Unique identifier.

name
string
required

Name of hsVendor.

OrgId
number
required

Unique identifier for the organization associated with a specific vendor in the health services sector.