Skip to content

Get location revenue settings

GET
/v1/brands/{brandId}/locations/{locationId}/revenue-settings
curl --request GET \
--url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revenue-settings \
--header 'Authorization: Bearer <token>'
brandId
required
string format: uuid

Brand identifier

locationId
required
string format: uuid

Location identifier

Success

Media type application/json
object
data
required
object
settings
required
object
avgTicketCents
required

Average ticket value in cents

integer | null
closeRatePct
required

Close rate percentage as decimal string

string | null
baselineRating
required

Baseline rating as decimal string

string | null
trailing90dRevenueCents
required

Trailing 90-day revenue in cents

integer | null
inputsLastUpdatedAt
required

Last time inputs were updated

string | null format: date-time
platformData
required
object
formLeadsMtd
required

Form leads submitted this calendar month

integer
integrations
required
object
call_tracking
required

Whether a call tracking integration is connected

boolean
google_business_profile
required

Whether Google Business Profile is connected

boolean
booking
required

Whether a booking integration is connected

boolean
Example generated
{
"data": {
"settings": {
"avgTicketCents": 1,
"closeRatePct": "example",
"baselineRating": "example",
"trailing90dRevenueCents": 1,
"inputsLastUpdatedAt": "2026-04-15T12:00:00Z"
},
"platformData": {
"formLeadsMtd": 1,
"integrations": {
"call_tracking": true,
"google_business_profile": true,
"booking": true
}
}
}
}

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}