Skip to main content
GET
Get a link to an invoice's PDF

Authorizations

Authorization
string
header
required

An API key created in Settings, sent as Authorization: Bearer <key>.

Path Parameters

id
string<uuid>
required

The invoice id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Successful response

downloadUrl
string
required

A link to the file. It works for one hour after this response, and anyone holding it can download the file. Do not send your API key with it: the link points at Synthetic's file storage, not the API. For a new link, call the route again.