Skip to main content
GET
Get Entitlement AppStore Settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entitlement_uuid
string
required

The entitlement's ID, which GET /v1/entitlements and GET /v1/apps/{app_uuid}/entitlements return as id.

Response

Successful Response

visible_in_appstore
boolean
required

Whether this entitlement is visible in the AppStore catalog.

allowed_requester_group_uuids_override
string[] | null

UUIDs of groups whose members may request this entitlement, overriding the app's allowed requester groups. null means this entitlement inherits the app's allowed requester groups. An empty list means the override is on with no group restriction: anyone can request this entitlement, even if the app restricts requesters.

time_based_access_override
TimeBasedAccessOverride · object | null

This entitlement's own time-based access options. Null means this entitlement inherits the app's time-based access options.

request_validation_webhook_uuid
string | null

UUID of the inline webhook called to validate access requests for this entitlement. null means no webhook is set on this entitlement. Nothing is inherited from the app.