app.certified.actor.organization

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Extended metadata for an organization actor. Complements the base actor profile (app.certified.actor.profile), which holds the display name, description, website, avatar, and banner, with organization-specific fields such as legal name, full logo, public contact email, legal structure, reference links, and locations.",
      "key": "literal:self",
      "record": {
        "properties": {
          "additionalLocations": {
            "description": "Strong references to further locations where the organization operates, such as branches, outlets, or field offices. Excludes the primary location, which is in location; do not repeat it here. Each referenced record must conform with the lexicon app.certified.location. As with location, update a reference whenever its record is edited.",
            "items": {
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "maxLength": 1000,
            "type": "array"
          },
          "createdAt": {
            "description": "Client-declared timestamp when this record was originally created.",
            "format": "datetime",
            "type": "string"
          },
          "foundedDate": {
            "description": "When the organization was established. Stored as datetime per ATProto conventions (no date-only format exists). Clients should use midnight UTC (e.g., '2005-01-01T00:00:00.000Z'); consumers should treat only the date portion as canonical.",
            "format": "datetime",
            "type": "string"
          },
          "legalName": {
            "description": "The organization's registered legal name. The public-facing name belongs in app.certified.actor.profile displayName.",
            "maxGraphemes": 256,
            "maxLength": 2560,
            "type": "string"
          },
          "location": {
            "description": "A strong reference to the organization's primary location: where it is based, and where it is shown when a map displays one point per organization. The referenced record must conform with the lexicon app.certified.location. Because a strong reference pins a specific version (CID) of that record, update this reference whenever the location record is edited. Further locations go in additionalLocations.",
            "ref": "com.atproto.repo.strongRef",
            "type": "ref"
          },
          "logo": {
            "description": "The organization's full logo: a wordmark, or a combination mark pairing the symbol with the name. Used where the logo appears without the name beside it, such as partner listings or badge displays. Prefer a horizontal image with a transparent background (PNG or WebP). The square symbol alone (brandmark) belongs in app.certified.actor.profile avatar, which is cropped to a square or circle.",
            "refs": [
              "org.hypercerts.defs#uri",
              "org.hypercerts.defs#smallImage"
            ],
            "type": "union"
          },
          "longDescription": {
            "description": "Long-form description of the organization, such as its mission, history, or detailed project narrative. An inline string for plain text or markdown, a Leaflet linear document record embedded directly, or a strong reference to an existing document record.",
            "refs": [
              "org.hypercerts.defs#descriptionString",
              "pub.leaflet.pages.linearDocument",
              "com.atproto.repo.strongRef"
            ],
            "type": "union"
          },
          "organizationType": {
            "description": "Legal or operational structures of the organization (e.g. 'nonprofit', 'ngo', 'government', 'social-enterprise', 'cooperative').",
            "items": {
              "maxGraphemes": 100,
              "maxLength": 128,
              "type": "string"
            },
            "maxLength": 10,
            "type": "array"
          },
          "publicEmail": {
            "description": "A contact email address the organization wants shown publicly (e.g. 'hello@example.org'). Records are public, so never put a personal or internal address here.",
            "maxLength": 254,
            "type": "string"
          },
          "signatures": {
            "description": "Optional cryptographic signatures attesting to this record's content.",
            "ref": "app.certified.signature.defs#list",
            "type": "ref"
          },
          "urls": {
            "description": "Additional reference URLs, each with a display label: social media profiles, contact pages, donation links, and similar. The organization's main website belongs in app.certified.actor.profile website, not here.",
            "items": {
              "ref": "#urlItem",
              "type": "ref"
            },
            "type": "array"
          },
          "visibility": {
            "description": "Controls whether the organization or project is publicly discoverable on platforms that honor this setting.",
            "knownValues": [
              "public",
              "unlisted"
            ],
            "type": "string"
          }
        },
        "required": [
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "urlItem": {
      "description": "A labeled URL reference.",
      "properties": {
        "label": {
          "description": "Optional human-readable label for this URL (e.g. 'Donation page').",
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "url": {
          "description": "The URL.",
          "format": "uri",
          "maxGraphemes": 2048,
          "maxLength": 10000,
          "type": "string"
        }
      },
      "required": [
        "url"
      ],
      "type": "object"
    }
  },
  "id": "app.certified.actor.organization",
  "lexicon": 1
}