list_data_shares

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "explicit",
              "floor"
            ],
            "description": "floor (the documents the party holds a seat on) or explicit (a share).",
            "x-data-class": "operational"
          },
          "data_share_id": {
            "type": [
              "string",
              "null"
            ],
            "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
            "format": "uuid",
            "description": "The share; null for the floor, which has no row.",
            "x-data-class": "operational"
          },
          "party_id": {
            "type": "string",
            "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
            "format": "uuid",
            "description": "The counterparty.",
            "x-data-class": "operational"
          },
          "party_name": {
            "type": "string",
            "description": "The counterparty's name in the directory.",
            "x-data-class": "operational"
          },
          "query": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "vendor_bill_request",
              "vendor_forecast",
              "vendor_sell_through",
              null
            ],
            "description": "The saved query; null for the floor.",
            "x-data-class": "operational"
          },
          "title": {
            "type": "string",
            "description": "What it is called.",
            "x-data-class": "operational"
          },
          "recipients": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(\\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*@([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?\\.)+([A-Za-z]{2,}|[Xx][Nn]--[A-Za-z0-9-]*[A-Za-z0-9])$",
                  "maxLength": 254
                },
                "uniqueItems": true
              },
              {
                "const": "•••",
                "description": "Masked by the caller's data policy."
              },
              {
                "type": "null",
                "description": "Denied by the caller's data policy."
              }
            ],
            "description": "Who a share is emailed to; empty for the floor.",
            "x-data-class": "personal"
          },
          "cadence": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "daily",
              "hourly",
              null
            ],
            "description": "How often a share is emailed; null for the floor.",
            "x-data-class": "operational"
          },
          "documents": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0,
            "description": "For the floor, how many documents; null for a share.",
            "x-data-class": "operational"
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When a share was created; null for the floor.",
            "x-data-class": "operational"
          },
          "revoked_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When a share was revoked, or null.",
            "x-data-class": "operational"
          },
          "declined_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the receiving org stopped receiving it (decline_data_share), or null.",
            "x-data-class": "operational"
          },
          "declined_by_org_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "The org that declined it: the one that has claimed the counterparty; null unless declined.",
            "x-data-class": "operational"
          },
          "revocable": {
            "type": "boolean",
            "description": "Whether revoke_data_share can revoke it: a live share can; the floor and a revoked or declined share never.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "kind",
          "data_share_id",
          "party_id",
          "party_name",
          "query",
          "title",
          "recipients",
          "cadence",
          "documents",
          "created_at",
          "revoked_at",
          "declined_at",
          "declined_by_org_name",
          "revocable"
        ],
        "additionalProperties": false
      }
    },
    "next_after": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass as `after` for the next page; null on the last one."
    }
  },
  "required": [
    "items",
    "next_after"
  ],
  "additionalProperties": false
}