---
updatedAt: 2026-09-10T06:16:17.000Z
agentTools:
  projectIndex: https://developer.vouchfor.com/llms.txt
---

# List Advocacy Request Shares

List Advocacy Request Shares

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Vouch",
    "description": "test",
    "termsOfService": "https://vouchfor.com/terms",
    "contact": {
      "name": "Vouch API Support",
      "email": "support@vouchfor.com"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://{environment}.vouchfor.com/v1",
      "variables": {
        "environment": {
          "default": "api",
          "enum": [
            "api",
            "api-staging"
          ]
        }
      }
    },
    {
      "url": "https://{environment}.vouchfor.com/v1/entities/{entityId}",
      "variables": {
        "environment": {
          "default": "api",
          "enum": [
            "api",
            "api-staging"
          ]
        },
        "entityId": {
          "default": "demo",
          "description": "Entity ID"
        }
      }
    }
  ],
  "components": {
    "parameters": {
      "Id": {
        "name": "id",
        "in": "path",
        "description": "Resource id - can be id or external id",
        "required": true,
        "allowEmptyValue": false,
        "schema": {
          "type": "string"
        }
      }
    },
    "responses": {
      "AdvocacyShares": {
        "description": "List of Advocacy Shares",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Id of the entity or advocacy request the shares belong to"
                },
                "shares": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Share"
                  }
                }
              }
            }
          }
        }
      },
      "NotFoundError": {
        "description": "The requested resource is not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Not Found."
            }
          }
        }
      },
      "UnauthorizedError": {
        "description": "Invalid API key",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Unauthorized."
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Internal Server Error."
            }
          }
        }
      }
    },
    "schemas": {
      "EngagementMetrics": {
        "type": "object",
        "description": "LinkedIn engagement metrics",
        "properties": {
          "impressions": {
            "type": "integer",
            "minimum": 0,
            "example": 100
          },
          "reach": {
            "type": "integer",
            "minimum": 0,
            "example": 80
          },
          "reshares": {
            "type": "integer",
            "minimum": 0,
            "example": 5
          },
          "reactions": {
            "type": "integer",
            "minimum": 0,
            "example": 20
          },
          "comments": {
            "type": "integer",
            "minimum": 0,
            "example": 3
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        }
      },
      "Share": {
        "type": "object",
        "properties": {
          "createddate": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updateddate": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "id": {
            "type": "string",
            "readOnly": true
          },
          "type": {
            "type": "string",
            "example": "POST"
          },
          "name": {
            "type": "string",
            "description": "Share owner name"
          },
          "source": {
            "type": "string",
            "description": "Source channel",
            "example": "LINKEDIN"
          },
          "url": {
            "type": "string",
            "format": "uri",
            "description": "External URL of the share"
          },
          "reach": {
            "type": "integer"
          },
          "metrics": {
            "$ref": "#/components/schemas/EngagementMetrics"
          },
          "reactions": {
            "type": "integer"
          },
          "key": {
            "type": "string",
            "description": "Source media key"
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "ApiKey": []
    }
  ],
  "tags": [
    {
      "name": "Advocacy"
    }
  ],
  "paths": {
    "/advocacy/requests/{id}/shares": {
      "get": {
        "summary": "List Advocacy Request Shares",
        "description": "List Advocacy Request Shares",
        "tags": [
          "Advocacy"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Id"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/AdvocacyShares"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "404": {
            "$ref": "#/components/responses/NotFoundError"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  }
}
```