SPA PDF Overlays

SPA: Retrieves a single PDF overlay

Returns a single PDF overlay by ID, including the PDF as base64 data URI.

GET/api/spa/pdf-overlays/{id}

SPA: Retrieves a single PDF overlay

curl --request GET \
  --url 'https://app.output.rocks/api/spa/pdf-overlays/string' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "id": 12345,
  "name": "DIN A4 letterhead overlay",
  "fileName": "letterhead.pdf",
  "file": "string",
  "createdBy": "user1@company.com",
  "updatedBy": "user1@company.com",
  "createdAt": "2024-08-23T00:00:00+00:00",
  "updatedAt": "2024-08-23T00:00:00+00:00",
  "subClientDefault": false,
  "subClientId": 3,
  "subClientDescription": "Branch Office A"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

PdfOverlay identifier

Response

200application/json

PdfOverlay resource

integer

Identifier generated by Output.Rocks.

Example: 12345

name

stringrequired

Name of the PDF overlay.

Example: "DIN A4 letterhead overlay"

fileName

stringrequired

Original PDF file name.

Example: "letterhead.pdf"

file

value

createdBy

string

User, created this entry

Example: "user1@company.com"

updatedBy

string

User, updated this entry

Example: "user1@company.com"

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

subClientDefault

boolean

Default for environmental tenants (sub-clients)

Available options: truefalse

Example: false

subClientId

integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription

string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"