SPA PDF Overlays

SPA: Retrieves a paginated list of PDF overlays

Returns a paginated list of PDF overlays for the authenticated user's client.

GET/api/spa/pdf-overlays

SPA: Retrieves a paginated list of PDF overlays

curl --request GET \
  --url 'https://app.output.rocks/api/spa/pdf-overlays?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Bname%5D=asc&order%5BfileName%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 12345,
    "name": "DIN A4 letterhead overlay",
    "fileName": "letterhead.pdf",
    "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.

Query Parameters

page

integerdefault:1

The collection page number

itemsPerPage

integerdefault:20

The number of items per page

pagination

boolean

Enable or disable pagination

order[id]

stringdefault:asc

No description provided.

order[name]

stringdefault:asc

No description provided.

order[fileName]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

subClient

string

No description provided.

subClient[]

string[]

No description provided.

string

Search across multiple fields (name, fileName) using OR logic with partial matching.

Response

200application/json

PdfOverlay collection

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"

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"