Skip to content

SharedSpacePersonResponseDto

Endpoints · All schemas

FieldRequiredDescription
assetCountYesItems in the shared space that show this person. Media marked sensitive, and Locked media, are not counted.
canUnlinkYesTrue when the caller may remove this link
coverAssetIdYesAn item already in the shared space that shows this person, used as the tile picture
idYesThe link ID. Not a person ID: a person is never disclosed across a space.
linkedAtYesWhen the person was linked
linkedByYesThe member who linked this person
nameYesThe name this shared space uses, independent of the owner's own name for them

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: UserResponseDto

{
  "properties": {
    "assetCount": {
      "description": "Items in the shared space that show this person. Media marked sensitive, and Locked media, are not counted.",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "canUnlink": {
      "description": "True when the caller may remove this link",
      "type": "boolean"
    },
    "coverAssetId": {
      "description": "An item already in the shared space that shows this person, used as the tile picture",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "id": {
      "description": "The link ID. Not a person ID: a person is never disclosed across a space.",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "linkedAt": {
      "description": "When the person was linked",
      "format": "date-time",
      "type": "string"
    },
    "linkedBy": {
      "$ref": "#/components/schemas/UserResponseDto",
      "description": "The member who linked this person"
    },
    "name": {
      "description": "The name this shared space uses, independent of the owner's own name for them",
      "type": "string"
    }
  },
  "required": [
    "assetCount",
    "canUnlink",
    "coverAssetId",
    "id",
    "linkedAt",
    "linkedBy",
    "name"
  ],
  "type": "object"
}