Download Guest Profile

GET /guest-profiles/::guestProfileId/download

Download a guest profile as a document. Supported formats are HTML, DOCX, and PDF.

TOKEN

Authentication

This endpoint requires an API token. You can learn more about how to get an API token from the authentication page.

URL

https://api.podengine.ai/api/v1/guest-profiles/:guestProfileId/download

Code Example

API Specification

Path Parameters

PropertyTypeDescription
guestProfileId
string

The guest profile ID

Query Parameters

PropertyTypeDescription
format
enum ⓘ

Allowed values

htmldocxpdf

The format to download the guest profile in. Supported formats: html, docx, pdf

200

Success Response

This endpoint returns a raw file download (no JSON response body).