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

# Get Link

Get link from the Vouch library by ID

# 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": {
      "Link": {
        "description": "Full Link Object",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "account": {
                  "$ref": "#/components/schemas/Account"
                },
                "entity": {
                  "$ref": "#/components/schemas/Entity"
                },
                "link": {
                  "$ref": "#/components/schemas/Link"
                }
              }
            }
          }
        }
      },
      "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": {
      "Account": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "example": "david@vouchfor.com"
          },
          "name": {
            "type": "string",
            "example": "David Stirk"
          }
        }
      },
      "Entity": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "externalid": {
                "type": "string",
                "minLength": 1,
                "maxLength": 50,
                "example": "my-application-id"
              },
              "createddate": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "example": "2021-01-01T12:00:00.000Z"
              },
              "updateddate": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "example": "2022-01-01T12:00:00.000Z"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "note": {
                "$ref": "#/components/schemas/Note"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "readOnly": true,
                "example": "eeeeeeeeee"
              },
              "name": {
                "type": "string",
                "example": "Vouch"
              },
              "logo": {
                "type": "string",
                "format": "uri",
                "example": "https://img.logo.dev/vouchfor.com?token=pk_XzHPPDjZTBikQbIi3iLD0A&size=260"
              },
              "url": {
                "type": "string",
                "format": "uri",
                "example": "https://vouchfor.com"
              }
            }
          }
        ]
      },
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        }
      },
      "File": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "externalid": {
                "type": "string",
                "minLength": 1,
                "maxLength": 50,
                "example": "my-application-id"
              },
              "createddate": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "example": "2021-01-01T12:00:00.000Z"
              },
              "updateddate": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "example": "2022-01-01T12:00:00.000Z"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "readOnly": true,
                "example": "ffffffffff"
              },
              "name": {
                "type": "string",
                "example": "My File"
              },
              "download": {
                "type": "string",
                "format": "uri",
                "readOnly": true,
                "description": "Direct download URL for the file",
                "example": "https://d2rxhdlm2q91uk.cloudfront.net/files/ffffffffff"
              },
              "thumbnail": {
                "type": "string",
                "format": "uri",
                "readOnly": true
              },
              "url": {
                "type": "string",
                "format": "uri",
                "readOnly": true,
                "description": "Public viewer URL for the file",
                "example": "https://app.vouchfor.com/f/ffffffffff"
              },
              "type": {
                "type": "string",
                "readOnly": true,
                "example": "IMAGE"
              },
              "admin": {
                "type": "string",
                "format": "uri",
                "readOnly": true
              },
              "approvalStatus": {
                "type": "string",
                "readOnly": true,
                "example": "APPROVED"
              },
              "status": {
                "type": "string",
                "readOnly": true,
                "example": "COMPLETE"
              },
              "source": {
                "type": "string",
                "readOnly": true,
                "description": "Source URL the file was imported from",
                "example": "https://vouchfor.com"
              },
              "tags": {
                "type": "array",
                "readOnly": true,
                "items": {
                  "type": "string"
                }
              }
            }
          }
        ]
      },
      "Link": {
        "allOf": [
          {
            "$ref": "#/components/schemas/File"
          },
          {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "format": "uri",
                "example": "https://vouchfor.com"
              }
            }
          }
        ]
      },
      "Note": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "example": "thanks for Vouching for us!"
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "ApiKey": []
    }
  ],
  "tags": [
    {
      "name": "Link"
    }
  ],
  "paths": {
    "/links/{id}": {
      "get": {
        "summary": "Get Link",
        "description": "Get link from the Vouch library by ID",
        "tags": [
          "Link"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/Id"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/Link"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "404": {
            "$ref": "#/components/responses/NotFoundError"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  }
}
```