Understudy · Partner API

v0 · demo data · basic auth

Finished deliverables flow out. Raw data never does.

This API exposes what a role-holder has chosen to share — their deliverables and the role card — and nothing else. There are no endpoints for mail, threads, people or the underlying record. That's not a gap; it's the design.

What this is

Understudy reconstructs a role as it actually runs — on the role-holder's own machine, in their boundary — and turns it into transition deliverables: a knowledge-transfer document, a temporary handover, and a job description derived from the work actually done, plus an embeddable role card. When the person shares a deliverable, partners can render it in their own surface — a portal, a canvas, an ATS — attributed "from Understudy".

This v0 serves our public demo dataset (a fictional persona, Alex Rivera at "Meridian Retail Group") so you can build and test an integration end to end. See the interactive demo of the product itself at demo.understudy.team, and the one-slide architecture picture at understudy-connects.

The contract: the record is owned by the person whose role it is. Sharing is per-deliverable, by the owner, never wholesale — so this API will only ever serve finished outputs. If your integration needs the raw record, the answer is a product conversation, not an endpoint.

Base URL & auth

https://api.understudy.team/v0

HTTP Basic auth. For the demo dataset the credentials are public on purpose (the data is fictional; the auth demonstrates the integration pattern):

user: partner      password: understudy-demo

Production auth (per-tenant keys / OAuth, enterprise SSO alignment) is a deliberate later step — we'd rather design it carefully with a real partner than improvise it now.

Endpoints

GETPathReturns
/v0/rolesthe shared role records id, name, title, available deliverables, links
/v0/roles/{id}/deliverableslist for one role scope (permanent · temporary · jd), label, generated_at, link
/v0/roles/{id}/deliverables/{scope}one finished deliverable markdown (render it your way) + html (ready to embed) + attribution
/v0/roles/{id}/card.svgthe role at a glance an SVG card — drop it in an <img>

Try it

1 · List the shared roles

curl -u partner:understudy-demo https://api.understudy.team/v0/roles

2 · Fetch the knowledge-transfer document

curl -u partner:understudy-demo \
  https://api.understudy.team/v0/roles/alex-rivera/deliverables/permanent

Response: { scope, label, generated_at, attribution, markdown, html } — embed the html (e.g. iframe srcdoc) or restyle the markdown.

3 · Embed the role card

<img src="https://api.understudy.team/v0/roles/alex-rivera/card.svg"
     alt="Alex Rivera — role at a glance (from Understudy)" width="720">

(Your server fetches it with the basic-auth credentials and re-serves it, or you proxy the request — browsers don't attach basic auth to <img> tags across origins.)

Attribution

Deliverables render in your surface with the line "from Understudy · shared by the role-holder" (included in the payload). Keeping it visible is part of the deal — it tells the person whose record it is exactly where their shared deliverable went.

What's deliberately missing in v0

Webhooks (poll generated_at for now) · pagination (one demo role) · production auth & tenanting · write operations of any kind (there are none, and there won't be — sharing happens in Understudy, by the owner).

Questions

hello@understudy.team — we answer plainly.