Criteria List (`akoya_CriteriaList`)¶

A Criteria List associates a named collection of criteria rules with a segmentation or eligibility context — for example, "donors who gave more than $1000 in the past 12 months" or "scholarships open to first-generation students." It's a light joining entity; the actual rules live on the parent akoya_criteria record.

At a glance


Display name	Criteria List
Logical name	`akoya_CriteriaList`
Primary ID attribute	`akoya_criterialistid`
Primary name attribute	`akoya_criterialistcode`
Entity set name (Web API)	`akoya_criterialists`
Ownership	UserOwned
Change tracking	Disabled
Audit	Disabled

No change tracking, no audit

Unlike most akoyaGO entities, akoya_CriteriaList has change tracking and audit both disabled. Partners cannot use @odata.deltaLink incremental sync on this entity and cannot retrieve change history. For delta sync, poll by modifiedon. For audit requirements, look at the parent akoya_criteria record instead.

Web API¶

GET  {org}/api/data/v9.2/akoya_criterialists
GET  {org}/api/data/v9.2/akoya_criterialists({listid})
POST {org}/api/data/v9.2/akoya_criterialists
PATCH {org}/api/data/v9.2/akoya_criterialists({listid})

Attributes¶

Display name	Logical name	Type	Required	Max length
Criteria List Code	`akoya_criterialistcode`	String	ApplicationRequired	100
Criteria	`akoya_criteria`	Lookup → `akoya_criteria`	ApplicationRequired	—

Supported messages¶

Message	Supported
Create	✓
Retrieve	✓
RetrieveMultiple	✓
Update	✓
Delete	✓
Upsert	— (no alternate keys; use GET then PATCH)

Examples¶

Conventions

Examples assume ORG (env URL), access_token (valid bearer), headers (standard Dataverse headers dict), and service (a ServiceClient instance). See Authentication.

List criteria for a criteria set¶

Web APIcurlPythonC#

GET {org}/api/data/v9.2/akoya_criterialists?
  $select=akoya_criterialistcode&
  $expand=akoya_Criteria($select=akoya_name)
Accept: application/json
OData-Version: 4.0
OData-MaxVersion: 4.0

curl "https://{org}.crm.dynamics.com/api/data/v9.2/akoya_criterialists?\$select=akoya_criterialistcode&\$expand=akoya_Criteria(\$select=akoya_name)" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "OData-Version: 4.0" \
  -H "OData-MaxVersion: 4.0"

r = requests.get(
    f"{ORG}/api/data/v9.2/akoya_criterialists",
    params={
        "$select": "akoya_criterialistcode",
        "$expand": "akoya_Criteria($select=akoya_name)",
    },
    headers=headers,
)
criteria_lists = r.json()["value"]

var query = new QueryExpression("akoya_CriteriaList") {
    ColumnSet = new ColumnSet("akoya_criterialistcode", "akoya_criteria")
};
var criteriaLists = service.RetrieveMultiple(query);

Change history¶

Schema extracted from the Akoyanet solution XML on 2026-04-24.

Criteria List (akoya_CriteriaList)¶