Get Guest Profile Details

GET https://api.podengine.ai/api/v1/guest-profiles/:guestProfileIdOrProjectId

Get detailed information about a specific guest profile including bio, contact details, social media links, and documents

API token required Markdown for LLMs

OpenAPI spec

Example request

Install & configure

curl -X GET "https://api.podengine.ai/api/v1/guest-profiles/:guestProfileIdOrProjectId" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_TOKEN"

const options = {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  }
};

fetch("https://api.podengine.ai/api/v1/guest-profiles/:guestProfileIdOrProjectId", options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.get("https://api.podengine.ai/api/v1/guest-profiles/:guestProfileIdOrProjectId", headers=headers)
print(response.json())

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "YOUR_API_TOKEN");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var response = await client.GetAsync("https://api.podengine.ai/api/v1/guest-profiles/:guestProfileIdOrProjectId");
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.podengine.ai/api/v1/guest-profiles/:guestProfileIdOrProjectId", nil)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "YOUR_API_TOKEN")
	
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import { PodEngine } from '@podengine/sdk';

const pe = new PodEngine({ apiKey: process.env.PODENGINE_API_KEY });

const data = await pe.guestProfiles.getGuestProfileDetails({
  guestProfileIdOrProjectId: 'example-guest-profile-id',
});

console.log(data);

import os

from podengine import PodEngine

pe = PodEngine(api_key=os.environ["PODENGINE_API_KEY"])

data = pe.guest_profiles.get_guest_profile_details(
    guest_profile_id_or_project_id="example-guest-profile-id",
)

print(data)

200

Example response

{
  "status": "OK",
  "data": {
    "projectId": "string",
    "projectSlug": "string",
    "guestProfileId": "string",
    "guestProfileSlug": "string",
    "publicSlug": "string",
    "name": "string",
    "status": "ACTIVE",
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z",
    "documents": [
      {
        "name": "string",
        "id": "string",
        "size": 0,
        "status": "string",
        "fileType": "string",
        "dateExtracted": "2026-01-15T09:30:00.000Z"
      }
    ],
    "listedPodcastsCount": 0,
    "bookingUrl": "string",
    "companyName": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "onePagerUrl": "string",
    "phone": "string",
    "websiteUrl": "string",
    "imageUrl": "string",
    "createdBy": {
      "userId": "string",
      "email": "string"
    },
    "socialMediaLinks": [
      {
        "socialMediaType": "beehiiv",
        "url": "https://example.com",
        "lastScrapedAt": "2026-01-15T09:30:00.000Z",
        "lastScrapeFailedAt": "2026-01-15T09:30:00.000Z",
        "isScraping": true
      }
    ],
    "guestBio": {
      "additionalContext": "string",
      "areasOfExpertise": [
        "string"
      ],
      "goals": [
        "string"
      ],
      "longBio": "string",
      "shortBio": "string",
      "thingsToAvoid": [
        "string"
      ],
      "topicsToDiscuss": [
        "string"
      ]
    },
    "publicViewSettings": {
      "displayLinkedIn": true,
      "displaySocials": true,
      "displayPreviousPodcastAppearances": true,
      "marketingLetterMarkdownText": "string",
      "publicSlug": "string"
    }
  }
}

Request

Path parameters

guestProfileIdOrProjectIdstringrequired

The id of the project associated with the guest profile or the guest profile id.

Response

200 application/json

statusliteral: OKrequired

dataobjectrequired24 fields

projectIdstringrequired

projectSlugstringrequired

guestProfileIdstringrequired

guestProfileSlugstringrequired

publicSlugstringrequirednullable

namestringrequired

statusenumrequired

ACTIVEDRAFTPENDINGARCHIVEDERROR

createdAtdaterequired

updatedAtdaterequired

documentsarray of objectrequired6 fields

namestringrequired

idstringrequired

sizenumberrequired

statusstringrequired

fileTypestringrequired

dateExtracteddaterequirednullable

listedPodcastsCountnumberrequired

bookingUrlstringrequirednullable

companyNamestringrequirednullable

emailstringrequirednullable

firstNamestringrequirednullable

lastNamestringrequirednullable

onePagerUrlstringrequirednullable

phonestringrequirednullable

websiteUrlstringrequirednullable

imageUrlstringrequirednullable

createdByobjectrequired2 fields

userIdstringrequired

emailstringrequired

socialMediaLinksarray of objectrequired5 fields

socialMediaTypeenumrequired

Social platform associated with the profile URL.

beehiivbehanceblueskydiscordfacebookgithubinstagramlinkedinlinktreemastodonmediumpatreonpinterestredditsnapchatsoundcloudsubstackthreadstiktoktumblrtwitchtwittervimeowhatsappyoutube

urlstringrequiredurl

Full URL of the social media profile.

lastScrapedAtdaterequirednullable

lastScrapeFailedAtdaterequirednullable

isScrapingbooleanrequired

guestBioobjectrequirednullable7 fields

additionalContextstringrequirednullable

areasOfExpertisearray of stringrequired

goalsarray of stringrequired

longBiostringrequired

shortBiostringrequired

thingsToAvoidarray of stringrequired