social.passports.unitedStates.visit Documentation (EN)

main record

A visit to a US state or DC. Records the subdivision visited, the city and the place, and optionally the date.

Record Key tid Timestamp-based ID

Properties

city string Required

City visited within the subdivision.

maxLength: 100 bytes

createdAt string datetime Required

An RFC 3339 formatted timestamp.

note string Optional

The user's note about this visit.

maxLength: 3000 bytes

place ref social.passports.place Optional

The place visited, when known. Inline place object — no external fetch required.

subdivision string Required

ISO 3166-2 subdivision code, e.g. 'US-CA', 'US-NY', 'US-HI'.

maxLength: 6 bytes

visitDate string Optional

Date of visit in YYYY-MM-DD format. Nullable — user may not know the exact date.

maxLength: 10 bytes

View raw schema

{
  "description": "A visit to a US state or DC. Records the subdivision visited, the city and the place, and optionally the date.",
  "key": "tid",
  "record": {
    "properties": {
      "city": {
        "description": "City visited within the subdivision.",
        "maxLength": 100,
        "type": "string"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "note": {
        "description": "The user's note about this visit.",
        "maxLength": 3000,
        "type": "string"
      },
      "place": {
        "description": "The place visited, when known. Inline place object — no external fetch required.",
        "ref": "social.passports.place",
        "type": "ref"
      },
      "subdivision": {
        "description": "ISO 3166-2 subdivision code, e.g. 'US-CA', 'US-NY', 'US-HI'.",
        "maxLength": 6,
        "type": "string"
      },
      "visitDate": {
        "description": "Date of visit in YYYY-MM-DD format. Nullable — user may not know the exact date.",
        "maxLength": 10,
        "type": "string"
      }
    },
    "required": [
      "subdivision",
      "city",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}