API Reference

Print Mail

Reports

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Saved Reports

GET/print-mail/v1/reports

Retrieve a list of saved reports for your organization.

Query ParametersExpand Collapse

limit: optional number

formatint32

search: optional string

You can supply any string to help narrow down the list of resources. For example, if you pass "New York" (quoted), it will return resources that have that string present somewhere in their response. Alternatively, you can supply a structured search query. See the documentation on StructuredSearchQuery for more details.

skip: optional number

formatint32

ReturnsExpand Collapse

data: array of Report { id, createdAt, live, 5 more }

id: string

Unique identifier for the report.

createdAt: string

Timestamp when the report was created.

formatdate-time

live: boolean

Indicates if the report is associated with the live or test environment.

object: "report"

Always report.

sqlQuery: string

The SQL query defining the report.

updatedAt: string

Timestamp when the report was last updated.

formatdate-time

description: optional string

An optional user-friendly description for the report.

metadata: optional map[string]

Optional key-value metadata associated with the report.

limit: number

formatint32

object: "list"

skip: number

formatint32

totalCount: number

formatint32

List Saved Reports

HTTP

HTTP

TypeScript

Python

curl https://api.postgrid.com/print-mail/v1/reports \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

200 example

{
  "object": "list",
  "limit": 10,
  "skip": 0,
  "totalCount": 1,
  "data": [
    {
      "id": "report_123",
      "object": "report",
      "live": false,
      "sqlQuery": "SELECT id, status FROM orders WHERE created_at > ?",
      "description": "Recent Orders",
      "metadata": {
        "team": "Sales"
      },
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  ]
}

Returns Examples

200 example

{
  "object": "list",
  "limit": 10,
  "skip": 0,
  "totalCount": 1,
  "data": [
    {
      "id": "report_123",
      "object": "report",
      "live": false,
      "sqlQuery": "SELECT id, status FROM orders WHERE created_at > ?",
      "description": "Recent Orders",
      "metadata": {
        "team": "Sales"
      },
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  ]
}