Skip to main content
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

Gratuity configuration retrieved successfully.

​
enabled
boolean

Indicates if gratuity is enabled at the location.

​
shouldAllowCustomTip
boolean

Indicates if customers can enter a custom gratuity amount.

​
tipPercentage
string[]

An array of allowed gratuity percentages (as strings, e.g., '15', '18', '20').

​
defaultTipPercentage
string

The default gratuity percentage (as a string, e.g., '18.00').