Documents

[Beta] Document Summary

Returns a summary for the specified document. Use query parameter type to select summary granularity.

get/public/beta/documents/{document_id}/summary

Request

Base URL
https://api.pandadoc.com
Auth
- API key in header Authorization
- or OAuth 2
  Authorization codehttps://app.pandadoc.com/oauth2/authorize
  Token URLhttps://api.pandadoc.com/oauth2/access_token
TypeScript
https://skmtc.dev/pandadoc/apis/pandadoc-public-api/docs/public/beta/documents/:document_id/summary/get.ts
A function with typed inputs. Its response is checked against the schema.

document_idstring required

The unique identifier of the document.

type'detailed' | 'short' | 'headline' | 'xshort' required

Document summary granularity (query parameter type).

Document summary granularity to return.

Document Summary is available. JSON object with type and summary (see schema). Includes ETag and Vary: type headers.

type'detailed' | 'short' | 'headline' | 'xshort' required

Document summary granularity (query parameter type).

summarystring required

Summary text for the requested summary type.

No recorded changes to this operation across all 2 revisions of this API.