Parsequerade / docs
App Events
GET/events/{eventId}

Proposed · Extended read design · Adapter not implemented

Request

Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.

cURL
BASE='https://asc.example.com/v1/connections/conn_example'

curl --fail-with-body "$BASE/events/event_123" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
eventIdRequiredstringThe selected resource’s ID.

Query parameters

NameTypeDescription
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
ValuesreferenceName, badge, eventState, deepLink, purchaseRequirement, primaryLocale, priority, purpose, territorySchedules, archivedTerritorySchedules

Response

One flat object for the selected resource.

200 · application/json
{
  "id": "app_event_123",
  "referenceName": "Example subscription",
  "badge": "LIVE_EVENT",
  "eventState": "DRAFT",
  "deepLink": "https://example.com/asset",
  "purchaseRequirement": "purchase_requirement_example"
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
referenceNamestringThe internal reference name configured for this resource.
badgestringThe badge value reported by Apple for this resource.
ValuesLIVE_EVENT, PREMIERE, CHALLENGE, COMPETITION, NEW_SEASON, MAJOR_UPDATE, SPECIAL_EVENT
eventStatestringThe event state value reported by Apple for this resource.
ValuesDRAFT, READY_FOR_REVIEW, WAITING_FOR_REVIEW, IN_REVIEW, REJECTED, ACCEPTED, APPROVED, PUBLISHED, PAST, ARCHIVED
deepLinkstring · uriThe deep link URL reported by Apple.
purchaseRequirementstringThe purchase requirement value reported by Apple for this resource.
primaryLocalestringThe app’s primary locale. It does not cause automatic locale fallback.
prioritystringThe priority value reported by Apple for this resource.
ValuesHIGH, NORMAL
purposestringThe purpose value reported by Apple for this resource.
ValuesAPPROPRIATE_FOR_ALL_USERS, ATTRACT_NEW_USERS, KEEP_ACTIVE_USERS_INFORMED, BRING_BACK_LAPSED_USERS
territorySchedulesobject[]The territory schedules value reported by Apple for this resource.
archivedTerritorySchedulesobject[]The archived territory schedules value reported by Apple for this resource.
territorySchedules fields
NameTypeDescription
territoriesOptionalstring[]The territories value reported by Apple for this resource.
publishStartOptionalstring · date-timePublish start, as an RFC 3339 timestamp.
eventStartOptionalstring · date-timeEvent start, as an RFC 3339 timestamp.
eventEndOptionalstring · date-timeEvent end, as an RFC 3339 timestamp.
archivedTerritorySchedules fields
NameTypeDescription
territoriesOptionalstring[]The territories value reported by Apple for this resource.
publishStartOptionalstring · date-timePublish start, as an RFC 3339 timestamp.
eventStartOptionalstring · date-timeEvent start, as an RFC 3339 timestamp.
eventEndOptionalstring · date-timeEvent end, as an RFC 3339 timestamp.

Behavior

  • A nested resource must belong to the selected parent and the configured connection. The adapter validates ownership before returning data.

Errors

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404resource_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream errorApple authentication, response parsing, availability, or timeout failure; this is not an empty result.

Apple mapping

Upstream route and translation

The adapter calls GET /v1/appEvents/{id}. Read Apple’s original endpoint ↗

Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.

Facade parameterTypeDescription
fieldsqueryfields[appEvents]

Reviewed 2026-10-14 · OpenAPI 4.5.1