GET
/
api
/
v1
/
locations
/
{locationId}
/
gratuity
Get Gratuity Configuration
curl --request GET \
  --url https://api.cravejs.com/api/v1/locations/{locationId}/gratuity \
  --header 'X-API-Key: <api-key>'
{
  "enabled": true,
  "shouldAllowCustomTip": true,
  "tipPercentage": [
    "<string>"
  ],
  "defaultTipPercentage": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
locationId
string
required

The location's unique ID.

Response

200
application/json

Gratuity configuration retrieved successfully.

The response is of type object.