Explore

Get a company's pitch

Changed on

The Overview tab's pitch as structured data: the story as ordered blocks (heading, paragraph, list, image, video, footnote), plus the perk tiers of the round the page shows the viewer. Images and embedded videos keep their place in the document with an absolute URL, because founders publish perk tiers, stretch goals, timelines, and charts as pictures (typically with no alt text) and a plain-text rendering would drop them.

What is parsed is what the page renders: the story passes through the site's own sanitizer first, so an embed the page refuses (a host off its allowlist, a javascript: URL) is never served here either. Same "who has a page" rule and round chooser as GET /companies/{id}. A site-public company with no round the viewer may see still has a pitch (perks: null). perks.described_in_pitch is a heuristic: true when the structured perk list is a placeholder ("See investor overview page", or one identical sentence on every tier) and the real tiers are in the story's images.

authored_by says who wrote the story: company (the issuer's own words and imagery, not a Wefunder assessment) or wefunder (a Wefunder-prepared deal memo the company did not participate in; disclaimer carries the page's notice). A pitch can run to ~70 KB; use sections to ask for less.

get/companies/{id}/pitch

Request

  • Base URL: https://api.wefunder.com
  • URL: https://api.wefunder.com/companies/{id}/pitch
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://wefunder.com/oauth/authorize, token URL https://api.wefunder.com/oauth/token; client credentials, token URL https://api.wefunder.com/oauth/token, scopes: read:public)
    • OAuth 2 (authorization code, authorization URL https://wefunder.com/oauth/authorize, token URL https://api.wefunder.com/oauth/token; client credentials, token URL https://api.wefunder.com/oauth/token, scopes: read:explore)

Path parameters

idstring required

Query parameters

sectionsstring[]

Only these sections (offering_id, title, url, authored_by, and disclaimer are always included). Omit for the whole pitch. Unknown names are a 400 listing the vocabulary.

Response

Successful response

Changes

    • info

      the security scope read:public was added to the endpoint's security scheme bearerAuth

    • info

      the security scope read:explore was removed from the endpoint's security scheme bearerAuth

    • info

      endpoint added