# ai.newnal.illi.artwork.getFamilyWork

> Device app. One received work by its delivery: the card and whether its manifest can still be read. Works outside today's recommendations included.

- Kind: query
- Authority: artwork.illi.newnal.ai
- Lexicon: 1
- Published by [illi-service.newnal.id](https://lexicon.garden/identity/did:plc:uztm7bi2ce42dez3uu3qafro), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.artwork.getFamilyWork)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.artwork.getFamilyWork/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.artwork.getFamilyWork/analytics)

## Query (`ai.newnal.illi.artwork.getFamilyWork`)

Type: query · GET

### Parameters (query string)

- `deliveryId` (string, required)
  - Constraints: minLength: 1, maxLength: 64
- `homeId` (string · tid, required)

### Output (application/json)

- `card` (ref, required)
  - Reference: `ai.newnal.illi.artwork.defs#familyWorkCard`
- `manifestAvailable` (boolean, required)

### Errors

- `NotDevice`: No description in schema.
- `NotMember`: No description in schema.
- `ArtworkNotFound`: No description in schema.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Device app. One received work by its delivery: the card and whether its manifest can still be read. Works outside today's recommendations included.",
      "errors": [
        {
          "name": "NotDevice"
        },
        {
          "name": "NotMember"
        },
        {
          "name": "ArtworkNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "card": {
              "ref": "ai.newnal.illi.artwork.defs#familyWorkCard",
              "type": "ref"
            },
            "manifestAvailable": {
              "type": "boolean"
            }
          },
          "required": [
            "card",
            "manifestAvailable"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "deliveryId": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "homeId": {
            "format": "tid",
            "type": "string"
          }
        },
        "required": [
          "homeId",
          "deliveryId"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "ai.newnal.illi.artwork.getFamilyWork",
  "lexicon": 1
}
```