---
title: "Get OpenGraph info for a CarbonLink"
method: GET
path: "/opengraph/link/{name}"
tags: ["Open Graph"]
---

# Get OpenGraph info for a CarbonLink

`GET /opengraph/link/{name}`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/opengraph/link/{name}`
- Auth: none declared

## Path parameters

- `name` string, required

## Response `200`

- CarbonLinkResponse
  - `success` boolean, required
  - `data` CarbonLink, required
    - `url` string, required
    - `title` string, required
    - `description` string
    - `author` string
    - `locale` string
    - `type` 'standard' | 'webcontact' | 'personallink'
    - `sitename` string
    - `audio_url` string
    - `audio_type` string
    - `image_url` string
    - `image_type` string
    - `image_width` number
    - `image_height` number
    - `first_name` string, required
    - `last_name` string
    - `vanity_name` string, required

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)