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

[ { "id": 12345, "value": { "contract": { "email": "john.doe@output.rocks" }, "invoiceNumber": "123456", "invoiceDate": "12 March 2022", "items": [ { "qty": "3", "ItemName": "ACP101 Accounting Package", "amt": "1350.00" }, { "qty": "4.5", "ItemName": "ACP101S Standard Support", "amt": "450.00" }, { "qty": "10", "ItemName": "ACP101T Online Training", "amt": "1200.00" } ] }, "appValue": [ "string" ], "renderingRequestId": 123, "emailProcesses": [ { "id": 123, "description": "", "sender": "string", "emailTo": "user@example.com", "cc": "string", "bcc": "string", "fromName": "Example name", "replyTo": "string", "subject": "string", "body": "string", "text": "string", "metadata": [ "string" ], "externalId": "string", "externalState": "string", "messageId": "string", "fileName": "", "docPath": "string", "sendStatus": "string", "customId": "string", "template": "https://example.com/", "renderData": "https://example.com/", "webhooks": [ { "id": null, "identifier": null, "email": null, "type": null, "priority": null, "data": null, "configuration": null, "createdBy": null, "updatedBy": null, "createdAt": null, "updatedAt": null, "client": null, "subClient": null, "active": null, "activeFrom": null, "versionGroup": null, "versionNumber": null, "supersededAt": null, "changeSummaryDe": null, "changeSummaryEn": null, "summaryStatus": null, "groupIdentifier": null, "groupCondition": null, "subClientDefault": null, "subClientId": null, "subClientDescription": null, "subClientColor": null } ], "mailServerConfiguration": "https://example.com/", "renderingRequest": "https://example.com/", "renderProcesses": [ { "id": null, "format": null, "type": null, "description": null, "fileName": null, "billablePages": null, "documentPages": null, "maxPageViolation": null, "docPath": null, "metadata": null, "billed": null, "externalId": null, "externalState": null, "customId": null, "template": null, "brandIdentifier": null, "brandVersionNumber": null, "brandLayoutPath": null, "renderStartedAt": null, "renderDurationMs": null, "renderData": null, "webhooks": null, "emailProcess": null, "xmlProcess": null, "renderingRequest": null, "failedDataValidators": null, "file": null, "createdBy": null, "updatedBy": null, "createdAt": null, "updatedAt": null, "client": null, "subClient": null, "state": null, "workflowLog": null, "blocked": null, "wfData": null, "batchAction": null, "doneAt": null, "anonymization": null, "anonymized": null, "reviewRequired": null, "reviewedBy": null, "reviewedAt": null, "prefix": null, "eInvoice": null, "renderingRequestOrNull": null, "subClientId": null, "subClientDescription": null, "subClientColor": null, "webhooksToExecute": null, "nextWebhookToExecute": null } ], "emailAttachments": [ { "id": null, "identifier": null, "description": null, "fileName": null, "path": null, "file": null, "createdBy": null, "updatedBy": null, "createdAt": null, "updatedAt": null, "client": null, "subClient": null, "brandIdentifier": null, "active": null, "activeFrom": null, "versionGroup": null, "versionNumber": null, "supersededAt": null, "changeSummaryDe": null, "changeSummaryEn": null, "summaryStatus": null, "groupIdentifier": null, "groupCondition": null, "validationCondition": null, "subClientDefault": null, "subClientId": null, "subClientDescription": null, "subClientColor": null } ], "emailNotification": { "id": null, "origin": null, "messageId": null, "type": null, "eventType": null, "emailProcess": null, "message": null, "metadata": null, "createdBy": null, "updatedBy": null, "createdAt": null, "updatedAt": null, "client": null, "subClient": null, "state": null, "workflowLog": null, "blocked": null, "wfData": null, "batchAction": null, "subClientId": null, "subClientDescription": null, "subClientColor": null }, "emailNotifications": [ { "id": null, "origin": null, "messageId": null, "type": null, "eventType": null, "emailProcess": null, "message": null, "metadata": null, "createdBy": null, "updatedBy": null, "createdAt": null, "updatedAt": null, "client": null, "subClient": null, "state": null, "workflowLog": null, "blocked": null, "wfData": null, "batchAction": null, "subClientId": null, "subClientDescription": null, "subClientColor": null } ], "failedDataValidators": [ { "id": null, "identifier": null, "description": null, "condition": null, "errorMessage": null, "invalidOnTrue": null, "templates": null, "emailTemplates": null, "createdBy": null, "updatedBy": null, "createdAt": null, "updatedAt": null, "client": null, "subClient": null, "active": null, "activeFrom": null, "versionGroup": null, "versionNumber": null, "supersededAt": null, "changeSummaryDe": null, "changeSummaryEn": null, "summaryStatus": null, "subClientDefault": null, "subClientId": null, "subClientDescription": null, "subClientColor": null } ], "client": {}, "subClient": {}, "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "state": "done", "workflowLog": "[2024-01-01 00:00:00] Rendering set to blocked because of paused Template", "blocked": false, "wfData": [ "string" ], "batchAction": "https://example.com/", "doneAt": "2024-08-23T00:00:00+00:00", "anonymization": "2024-08-23T00:00:00+00:00", "anonymized": false, "reviewRequired": false, "reviewedBy": "string", "reviewedAt": "2024-01-01T00:00:00Z", "prefix": "string", "renderingRequestOrNull": "https://example.com/", "subClientId": 3, "subClientDescription": "Branch Office A", "subClientColor": "#083E5D", "webhooksToExecute": true, "nextWebhookToExecute": "https://example.com/" } ], "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "client": {}, "subClient": {}, "subClientId": 3, "subClientDescription": "Branch Office A", "subClientColor": "#083E5D" } ]

SPA Render Data

SPA: Retrieves a paginated list of Render Data

Returns a paginated list of render data for the authenticated user's client.

GET/api/spa/render-data

SPA: Retrieves a paginated list of Render Data

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

200

application/json

[
  {
    "id": 12345,
    "value": {
      "contract": {
        "email": "john.doe@output.rocks"
      },
      "invoiceNumber": "123456",
      "invoiceDate": "12 March 2022",
      "items": [
        {
          "qty": "3",
          "ItemName": "ACP101 Accounting Package",
          "amt": "1350.00"
        },
        {
          "qty": "4.5",
          "ItemName": "ACP101S Standard Support",
          "amt": "450.00"
        },
        {
          "qty": "10",
          "ItemName": "ACP101T Online Training",
          "amt": "1200.00"
        }
      ]
    },
    "appValue": [
      "string"
    ],
    "renderingRequestId": 123,
    "emailProcesses": [
      {
        "id": 123,
        "description": "",
        "sender": "string",
        "emailTo": "user@example.com",
        "cc": "string",
        "bcc": "string",
        "fromName": "Example name",
        "replyTo": "string",
        "subject": "string",
        "body": "string",
        "text": "string",
        "metadata": [
          "string"
        ],
        "externalId": "string",
        "externalState": "string",
        "messageId": "string",
        "fileName": "",
        "docPath": "string",
        "sendStatus": "string",
        "customId": "string",
        "template": "https://example.com/",
        "renderData": "https://example.com/",
        "webhooks": [
          {
            "id": null,
            "identifier": null,
            "email": null,
            "type": null,
            "priority": null,
            "data": null,
            "configuration": null,
            "createdBy": null,
            "updatedBy": null,
            "createdAt": null,
            "updatedAt": null,
            "client": null,
            "subClient": null,
            "active": null,
            "activeFrom": null,
            "versionGroup": null,
            "versionNumber": null,
            "supersededAt": null,
            "changeSummaryDe": null,
            "changeSummaryEn": null,
            "summaryStatus": null,
            "groupIdentifier": null,
            "groupCondition": null,
            "subClientDefault": null,
            "subClientId": null,
            "subClientDescription": null,
            "subClientColor": null
          }
        ],
        "mailServerConfiguration": "https://example.com/",
        "renderingRequest": "https://example.com/",
        "renderProcesses": [
          {
            "id": null,
            "format": null,
            "type": null,
            "description": null,
            "fileName": null,
            "billablePages": null,
            "documentPages": null,
            "maxPageViolation": null,
            "docPath": null,
            "metadata": null,
            "billed": null,
            "externalId": null,
            "externalState": null,
            "customId": null,
            "template": null,
            "brandIdentifier": null,
            "brandVersionNumber": null,
            "brandLayoutPath": null,
            "renderStartedAt": null,
            "renderDurationMs": null,
            "renderData": null,
            "webhooks": null,
            "emailProcess": null,
            "xmlProcess": null,
            "renderingRequest": null,
            "failedDataValidators": null,
            "file": null,
            "createdBy": null,
            "updatedBy": null,
            "createdAt": null,
            "updatedAt": null,
            "client": null,
            "subClient": null,
            "state": null,
            "workflowLog": null,
            "blocked": null,
            "wfData": null,
            "batchAction": null,
            "doneAt": null,
            "anonymization": null,
            "anonymized": null,
            "reviewRequired": null,
            "reviewedBy": null,
            "reviewedAt": null,
            "prefix": null,
            "eInvoice": null,
            "renderingRequestOrNull": null,
            "subClientId": null,
            "subClientDescription": null,
            "subClientColor": null,
            "webhooksToExecute": null,
            "nextWebhookToExecute": null
          }
        ],
        "emailAttachments": [
          {
            "id": null,
            "identifier": null,
            "description": null,
            "fileName": null,
            "path": null,
            "file": null,
            "createdBy": null,
            "updatedBy": null,
            "createdAt": null,
            "updatedAt": null,
            "client": null,
            "subClient": null,
            "brandIdentifier": null,
            "active": null,
            "activeFrom": null,
            "versionGroup": null,
            "versionNumber": null,
            "supersededAt": null,
            "changeSummaryDe": null,
            "changeSummaryEn": null,
            "summaryStatus": null,
            "groupIdentifier": null,
            "groupCondition": null,
            "validationCondition": null,
            "subClientDefault": null,
            "subClientId": null,
            "subClientDescription": null,
            "subClientColor": null
          }
        ],
        "emailNotification": {
          "id": null,
          "origin": null,
          "messageId": null,
          "type": null,
          "eventType": null,
          "emailProcess": null,
          "message": null,
          "metadata": null,
          "createdBy": null,
          "updatedBy": null,
          "createdAt": null,
          "updatedAt": null,
          "client": null,
          "subClient": null,
          "state": null,
          "workflowLog": null,
          "blocked": null,
          "wfData": null,
          "batchAction": null,
          "subClientId": null,
          "subClientDescription": null,
          "subClientColor": null
        },
        "emailNotifications": [
          {
            "id": null,
            "origin": null,
            "messageId": null,
            "type": null,
            "eventType": null,
            "emailProcess": null,
            "message": null,
            "metadata": null,
            "createdBy": null,
            "updatedBy": null,
            "createdAt": null,
            "updatedAt": null,
            "client": null,
            "subClient": null,
            "state": null,
            "workflowLog": null,
            "blocked": null,
            "wfData": null,
            "batchAction": null,
            "subClientId": null,
            "subClientDescription": null,
            "subClientColor": null
          }
        ],
        "failedDataValidators": [
          {
            "id": null,
            "identifier": null,
            "description": null,
            "condition": null,
            "errorMessage": null,
            "invalidOnTrue": null,
            "templates": null,
            "emailTemplates": null,
            "createdBy": null,
            "updatedBy": null,
            "createdAt": null,
            "updatedAt": null,
            "client": null,
            "subClient": null,
            "active": null,
            "activeFrom": null,
            "versionGroup": null,
            "versionNumber": null,
            "supersededAt": null,
            "changeSummaryDe": null,
            "changeSummaryEn": null,
            "summaryStatus": null,
            "subClientDefault": null,
            "subClientId": null,
            "subClientDescription": null,
            "subClientColor": null
          }
        ],
        "client": {},
        "subClient": {},
        "createdBy": "user1@company.com",
        "updatedBy": "user1@company.com",
        "createdAt": "2024-08-23T00:00:00+00:00",
        "updatedAt": "2024-08-23T00:00:00+00:00",
        "state": "done",
        "workflowLog": "[2024-01-01 00:00:00] Rendering set to blocked because of paused Template",
        "blocked": false,
        "wfData": [
          "string"
        ],
        "batchAction": "https://example.com/",
        "doneAt": "2024-08-23T00:00:00+00:00",
        "anonymization": "2024-08-23T00:00:00+00:00",
        "anonymized": false,
        "reviewRequired": false,
        "reviewedBy": "string",
        "reviewedAt": "2024-01-01T00:00:00Z",
        "prefix": "string",
        "renderingRequestOrNull": "https://example.com/",
        "subClientId": 3,
        "subClientDescription": "Branch Office A",
        "subClientColor": "#083E5D",
        "webhooksToExecute": true,
        "nextWebhookToExecute": "https://example.com/"
      }
    ],
    "createdBy": "user1@company.com",
    "updatedBy": "user1@company.com",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "client": {},
    "subClient": {},
    "subClientId": 3,
    "subClientDescription": "Branch Office A",
    "subClientColor": "#083E5D"
  }
]

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[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

integer

No description provided.

id[]

integer[]

No description provided.

subClient

string

No description provided.

subClient[]

string[]

No description provided.

createdAt[before]

string

No description provided.

createdAt[strictly_before]

string

No description provided.

createdAt[after]

string

No description provided.

createdAt[strictly_after]

string

No description provided.

Response

200application/json

RenderData collection

integer

RenderData ID generated by Output.Rocks.

Example: 12345

value

object

Data Object

Example: {"contract":{"email":"john.doe@output.rocks"},"invoiceNumber":"123456","invoiceDate":"12 March 2022","items":[{"qty":"3","ItemName":"ACP101 Accounting Package","amt":"1350.00"},{"qty":"4.5","ItemName":"ACP101S Standard Support","amt":"450.00"},{"qty":"10","ItemName":"ACP101T Online Training","amt":"1200.00"}]}

appValue

string | null[]

renderingRequestId

integer | null

ID of the RenderingRequest associated with this render data.

emailProcesses

object[]

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"

client

object

subClient

object

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"

subClientColor

string

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

Example: "#083E5D"