Parsequerade / docs
Accessibility declarations
GET/accessibility-declarations/{accessibilityDeclarationId}

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/accessibility-declarations/accessibility_declaration_123" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

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

Path parameters

NameTypeDescription
accessibilityDeclarationIdRequiredstringThe 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.
ValuesdeviceFamily, state, supportsAudioDescriptions, supportsCaptions, supportsDarkInterface, supportsDifferentiateWithoutColorAlone, supportsLargerText, supportsReducedMotion, supportsSufficientContrast, supportsVoiceControl, supportsVoiceover

Response

One flat object for the selected resource.

200 · application/json
{
  "id": "accessibility_declaration_123",
  "deviceFamily": "IPHONE",
  "state": "DRAFT",
  "supportsAudioDescriptions": false,
  "supportsCaptions": false,
  "supportsDarkInterface": false
}

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.
deviceFamilystringThe device family value reported by Apple for this resource.
ValuesIPHONE, IPAD, APPLE_TV, APPLE_WATCH, MAC, VISION
statestringThe current state reported by Apple for this resource.
ValuesDRAFT, PUBLISHED, REPLACED
supportsAudioDescriptionsbooleanWhether Apple marks this resource as supports audio descriptions.
supportsCaptionsbooleanWhether Apple marks this resource as supports captions.
supportsDarkInterfacebooleanWhether Apple marks this resource as supports dark interface.
supportsDifferentiateWithoutColorAlonebooleanWhether Apple marks this resource as supports differentiate without color alone.
supportsLargerTextbooleanWhether Apple marks this resource as supports larger text.
supportsReducedMotionbooleanWhether Apple marks this resource as supports reduced motion.
supportsSufficientContrastbooleanWhether Apple marks this resource as supports sufficient contrast.
supportsVoiceControlbooleanWhether Apple marks this resource as supports voice control.
supportsVoiceoverbooleanWhether Apple marks this resource as supports voiceover.

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/accessibilityDeclarations/{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[accessibilityDeclarations]

Reviewed 2026-10-14 · OpenAPI 4.5.1