Skip to main content
GET
Get the engagement letter

Authorizations

X-API-Key
string
header
required

API key for authentication

Response

200 - application/json

The engagement letter, or availability: false when it is still gated.

available
boolean
required

False while the letter is gated on the first payment.

Example:

true

blockedReason
enum<string> | null
required

Why the letter is withheld, or null when it is available.

Available options:
first-invoice-unpaid
Example:

null

letter
object | null
required

The letter, or null exactly when available is false.