---
title: "PlatformApiObject"
description: "one object of a platform's API: the addresses that answer it, what it yields, the paths read from its JSON and the lists it carries"
section: concepts
address: /concepts/platformapiobject
contract: 0476e35e6e275db5
---

# PlatformApiObject

one object of a platform's API: the addresses that answer it, what it yields, the paths read from its JSON and the lists it carries

[figure: PlatformApiObject 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 |
|---|---|---|---|
| `name` | `text` | yes |  |
| `address_patterns` | `[text]` | yes |  |
| `yields` | `text` | yes |  |
| `fields` | [FieldSpec](/concepts/fieldspec) | yes |  |
| `lists` | [PlatformList](/concepts/platformlist) | yes |  |
| `needs` | `one of anyone \| signed in \| connected \| member \| admin \| premium \| licensed` | yes | what the viewer must be for the call to answer as described |



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