Contents

EligibilityQueryResponse

The paginated response object for an app eligibility query.

Declaration

object EligibilityQueryResponse

Properties

NameTypeDescription
result[EligibilityResponse]

Array of EligibilityResponse records matching the supplied filter criteria. Read-only.

paginationQueryPaginationResult

Pagination metadata for the response, including offset, pageSize, and totalCount. See QueryPaginationResult. Read-only.

errorError

Error information if the request encountered an error. See Error. Read-only.

Discussion

The eligibility query endpoint returns EligibilityQueryResponse as the paginated response.

To iterate through large result sets, use the totalCount and offset fields on the embedded QueryPaginationResult object.

Example

{
  "result": [
    {
      "adamId": 10738622087,
      "supplyPlacement": "APPSTORE_SEARCH_RESULTS",
      "supplySource": "APPSTORE",
      "minAge": 18,
      "state": "ELIGIBLE",
      "countryOrRegion": "US",
      "deviceClass": "IPHONE",
      "creationTime": "2026-02-05T08:30:00.000",
      "modificationTime": "2026-03-05T08:30:00.000"
    },
    {
      "adamId": 10738622087,
      "supplyPlacement": "APPSTORE_SEARCH_RESULTS",
      "supplySource": "APPSTORE",
      "minAge": 18,
      "state": "INELIGIBLE",
      "countryOrRegion": "BR",
      "deviceClass": "IPHONE",
      "creationTime": "2026-02-05T08:30:00.000",
      "modificationTime": "2026-03-05T08:30:00.000"
    }
  ],
  "pagination": {
    "pageSize": 20,
    "offset": 0,
    "totalCount": 2
  }
}

See Also