Skip to content

Get App Limit

GET
/apps/{app_id}/limit

PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.

This app’s hard credit cap, or null when it is uncapped.

null is the real answer, not an empty object: absence of a limit row IS “no cap”, and there is no unlimited sentinel — so an accidental zero can never read as no limit.

Authorizations

Parameters

Path Parameters

app_id
required
string

Header Parameters

X-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Any of:

An app’s hard credit cap. Mirrors AppLimitDto.

The endpoint returns null for no cap. There is no “unlimited” sentinel, so an accidental zero can never read as no limit.

object
app_id
required
string
created_at
Any of:
string format: date-time
credit_cap
required
integer
window
required

Cap window. calendar_month today.

string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string