---
title: "PlatformList"
description: "a list a page or an API answer carries whose items are things of the platform, each keyed by the first of its key paths that holds a value, and the relation between the page's thing and each item"
section: concepts
address: /concepts/platformlist
contract: 0476e35e6e275db5
---

# PlatformList

a list a page or an API answer carries whose items are things of the platform, each keyed by the first of its key paths that holds a value, and the relation between the page's thing and each item

[figure: PlatformList is a value at none scope. The drawing shows its fields and the objects that they point at.]

| property | value |
|---|---|
| kind | value |
| scope | none |
| key | none |
| store | none |
| family | sources |



## Fields


| field | type | required | note |
|---|---|---|---|
| `field` | `text` | yes |  |
| `thing` | `text` | yes | a thing of the domain |
| `relation` | `text` | no | a relation of the domain; absent when the items stand alone |
| `key_paths` | `[text]` | yes |  |
| `name_path` | `text` | no |  |
| `items_are_from` | `bool` | yes | true when each item takes the relation's from role and the page's thing its to role; false the other way round |
| `parent` | [PlatformListParent](/concepts/platformlistparent) | no | the thing each item belongs to, when the item carries its key: a comment's post, an edition's newsletter |
| `needs` | `one of anyone \| signed in \| connected \| member \| admin \| premium \| licensed` | yes | what the viewer must be to see the list at all |



## Routes that use it
No route takes or returns PlatformList directly. The record holds it, and the objects that point at it reach it.