# social.passports.folio

> Published by [passports.social](https://lexicon.garden/identity/did:plc:ssdgllkzfwekkpmu7expw6cv)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ssdgllkzfwekkpmu7expw6cv/social.passports.folio)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ssdgllkzfwekkpmu7expw6cv/social.passports.folio/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ssdgllkzfwekkpmu7expw6cv/social.passports.folio/examples)

## Definitions

### `social.passports.folio`

**Type**: `record`

A named grouping of entries within a single passport type, e.g. a trip in the travel passport or a set of train stops in an Amtrak passport.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `title` | `string` | Yes | Folio name, e.g. 'Japan Spring 2026'. |
| `entries` | `array` | Yes | Ordered list of strongrefs to the passport's entry records (e.g. social.passports.travel.leg, social.passports.fiftyStates.visit) belonging to this folio. |
| `createdAt` | `string` (datetime) | Yes |  |
| `updatedAt` | `string` (datetime) | No |  |
| `albumLinks` | `array` | No | Links to external photo albums for the folio. |
| `visibility` | `string` | Yes | Controls whether this folio is publicly visible. Acts as a display hint — individual entry visibility is the ground truth. |
| `description` | `string` | No | Free-text notes about the folio overall. |
| `passportType` | `string` | Yes | The passport type this folio belongs to, e.g. 'travel', 'fiftyStates', 'amtrak'. Tells consumers what record type to expect in entries. |

## Raw Schema

```json
{
  "id": "social.passports.folio",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "title",
          "passportType",
          "entries",
          "visibility",
          "createdAt"
        ],
        "properties": {
          "title": {
            "type": "string",
            "maxLength": 300,
            "description": "Folio name, e.g. 'Japan Spring 2026'."
          },
          "entries": {
            "type": "array",
            "items": {
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "maxLength": 200,
            "description": "Ordered list of strongrefs to the passport's entry records (e.g. social.passports.travel.leg, social.passports.fiftyStates.visit) belonging to this folio."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "updatedAt": {
            "type": "string",
            "format": "datetime"
          },
          "albumLinks": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            },
            "maxLength": 10,
            "description": "Links to external photo albums for the folio."
          },
          "visibility": {
            "type": "string",
            "description": "Controls whether this folio is publicly visible. Acts as a display hint — individual entry visibility is the ground truth.",
            "knownValues": [
              "public",
              "private"
            ]
          },
          "description": {
            "type": "string",
            "maxLength": 3000,
            "description": "Free-text notes about the folio overall."
          },
          "passportType": {
            "type": "string",
            "maxLength": 50,
            "description": "The passport type this folio belongs to, e.g. 'travel', 'fiftyStates', 'amtrak'. Tells consumers what record type to expect in entries."
          }
        }
      },
      "description": "A named grouping of entries within a single passport type, e.g. a trip in the travel passport or a set of train stops in an Amtrak passport."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
