Appointment7

Appointment Availability1

Booking4

Branch1

Branch Service4

Branch WorkTimeTable1

Break5

CheckIn1

Client8

Client Course3

Client Credit Account Transaction1

ClientCategory2

Course1

CSV Export Job2

Deposit1

Inventory Transaction1

Lead4

Loyalty Points1

Machine2

get/api/business/{businessId}/branch/{branchId}/machineGet a list of machines for the specified business id and branch id. List can be filtered by DateTime of update with a possibility to include archived machines
get/api/business/{businessId}/branch/{branchId}/machine/{machineId}Get a machine for the specified business id, branch id and machine id

PaymentType2

Product1

Purchase1

Review2

Room2

SaleFee3

Service Category1

Service Package1

Service Special Offer1

Staff3

Staff WorkTimeTable1

Stock1

Tax2

Till2

Till Session1

Time Off Policy2

Voucher4

Machine

Get a machine for the specified business id, branch id and machine id

Retrieve a machine

get/api/business/{businessId}/branch/{branchId}/machine/{machineId}

Request

Base URL
http://api-gateway-eu.phorest.com/third-party-api-server
Auth
HTTP basic
TypeScript
https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/machine/:machineId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

businessIdstring required

branchIdstring required

machineIdstring required

Response

Specified machine retrieved

machineIdstring required

namestring

descriptionstring

colorinteger

archivedboolean

Example response

{
  "machineId": "ab-123",
  "name": "123456",
  "description": "The machine description"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.