---
title: list transaction logs
slug: api-documentation/list-transaction-logs
createdAt: 2026-08-27T17:08:54.010Z
---

{
  "id": "9PjKMZ5cbNGbX646qLiDL",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.upstartcommerce.com/v1/tax/transactions",
    "servers": [
      {
        "url": "https://api.upstartcommerce.com/v1/tax/transactions",
        "description": "Dev Server"
      }
    ],
    "name": "list transaction logs",
    "description": "<p>One page of the transaction audit log: the calls made to the tax provider for the tenant, newest first, without the request and response bodies. Fetch a single record with its bodies through <code>GET /tax/transactions/{transactionId}</code>.</p>\n<p>The sites read are the caller's authorised sites, narrowed by <code>siteId</code> or, failing that, the <code>x-upstart-site</code> header. Logs are kept for 30 days; <code>from</code> is clamped to that window.</p>\n<p>Authorized permissions:</p>\n<ul>\n<li><code>tax.read</code></li>\n</ul>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        },
        {
          "kind": "required",
          "name": "x-upstart-tenant",
          "type": "string",
          "description": "Tenant identifier associated with the site this call is for."
        },
        {
          "kind": "optional",
          "name": "x-upstart-site",
          "type": "string",
          "description": "Unique identifier for the site."
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "siteId",
          "type": "string",
          "description": "<p>Restrict the list to one site. Absent means every site the request is authorised for.</p>\n<p>The <code>X-UpStart-Site</code> header wins where the two disagree. The request is authorised against that header, so a <code>siteId</code> naming a different site returns an empty page rather than another site's log - switching which site is being viewed means changing the header, not just this parameter. With no header the caller was admitted on tenant-level permissions, and <code>siteId</code> simply narrows to one of the tenant's sites.</p>"
        },
        {
          "kind": "optional",
          "name": "cartId",
          "type": "string",
          "description": "Exact match on the cart the calls were made for."
        },
        {
          "kind": "optional",
          "name": "transactionId",
          "type": "string<uuid>",
          "description": "Exact match on one transaction log id.",
          "format": "uuid"
        },
        {
          "kind": "optional",
          "name": "apiName",
          "type": "string",
          "description": "<p>Exact match on the provider operation, for example <code>CreateTransaction</code> or <code>CommitInvoice</code>.</p>"
        },
        {
          "kind": "optional",
          "name": "from",
          "type": "string<date-time>",
          "description": "<p>Inclusive lower bound on <code>creationDate</code>, ISO-8601. Defaults to the start of the retention window.</p>",
          "format": "date-time"
        },
        {
          "kind": "optional",
          "name": "to",
          "type": "string<date-time>",
          "description": "<p>Exclusive upper bound on <code>creationDate</code>, ISO-8601. Defaults to now.</p>",
          "format": "date-time"
        },
        {
          "kind": "optional",
          "name": "page",
          "type": "integer",
          "description": "<p>Zero-based page index.</p>",
          "default": 0,
          "minimum": 0
        },
        {
          "kind": "optional",
          "name": "pageSize",
          "type": "integer",
          "description": "<p>Rows per page, clamped to 100.</p>",
          "default": 10,
          "minimum": 1,
          "maximum": 100
        },
        {
          "kind": "optional",
          "name": "q",
          "type": "string",
          "description": "<p>Free-text search resolved by the shape of the value, so the caller does not have to know which column it matches. A value that parses as a UUID is looked up as a transaction id and then, failing that, as a cart id. Anything else is matched against the provider operation by case-insensitive prefix, so <code>commi</code> finds <code>CommitInvoice</code>.</p>\n<p>Partial values work for the operation name only: a fragment of a cart or transaction id cannot be looked up and returns an empty page. The request and response bodies are not searched.</p>\n<p>The operation names are a closed set - <code>CommitInvoice</code>, <code>CreateOrAdjustTransaction</code>, <code>CreateTransaction</code>, <code>RefundInvoice</code>, <code>RollbackInvoice</code> - and a prefix that matches none of them returns an empty page without reading the log. A type-ahead can therefore send every keystroke safely, though debouncing is still worth it for the prefixes that do match, since those read the whole requested window.</p>\n<p>Cannot be combined with <code>cartId</code>, <code>transactionId</code> or <code>apiName</code> - sending both is a 400 rather than one silently taking precedence.</p>"
        },
        {
          "kind": "optional",
          "name": "sort",
          "type": "string",
          "description": "<p>Column to order the page by, case-insensitive. <code>site</code> orders alphabetically by the site's display name, not by site id. Omit to keep the newest-first order this endpoint returns by default.</p>\n<p>Only these two columns are sortable: <code>creationDate</code> is the clustering key of the summary tables and the site is part of their partition key, so both are already ordered in storage.</p>",
          "enum": [
            "createdDate",
            "site"
          ]
        },
        {
          "kind": "optional",
          "name": "order",
          "type": "string",
          "description": "<p>Sort direction, case-insensitive. Defaults to <code>asc</code> when <code>sort</code> is given, and to <code>desc</code> when it is not, so naming a column starts it ascending while the unsorted list stays newest first.</p>",
          "enum": [
            "asc",
            "desc"
          ]
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "NoChannelPortalAccess",
          "name": "NoChannelPortalAccess",
          "kind": "optional",
          "type": "http",
          "description": "<p>This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "<p>Success - one page of transaction logs.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "One page of transaction logs plus the count of logs matching the filters before paging.",
            "customType": "TransactionListPage",
            "schema": [
              {
                "name": "items",
                "kind": "required",
                "type": "array",
                "description": "One transaction log without its request and response bodies.",
                "modelRef": "#/components/schemas/TransactionSummary",
                "customType": "TransactionSummary[]",
                "schema": [
                  {
                    "name": "transactionId",
                    "kind": "required",
                    "type": "string<uuid>",
                    "description": "",
                    "format": "uuid"
                  },
                  {
                    "name": "tenant",
                    "kind": "required",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "siteId",
                    "kind": "required",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "cartId",
                    "kind": "required",
                    "type": "string",
                    "description": "The cart the provider call was made for."
                  },
                  {
                    "name": "apiName",
                    "kind": "required",
                    "type": "string",
                    "description": "<p>The provider operation, for example <code>CreateTransaction</code>.</p>"
                  },
                  {
                    "name": "creationDate",
                    "kind": "required",
                    "type": "string<date-time>",
                    "description": "",
                    "format": "date-time"
                  },
                  {
                    "name": "roundTripTime",
                    "kind": "required",
                    "type": "integer<int64>",
                    "description": "<p>Provider round-trip time in nanoseconds.</p>",
                    "format": "int64"
                  }
                ]
              },
              {
                "name": "page",
                "kind": "required",
                "type": "integer",
                "description": ""
              },
              {
                "name": "pageSize",
                "kind": "required",
                "type": "integer",
                "description": ""
              },
              {
                "name": "total",
                "kind": "required",
                "type": "integer<int64>",
                "description": "<p>Logs matching the filters before paging; not the number of items on this page.</p>",
                "format": "int64"
              }
            ],
            "modelRef": "#/components/schemas/TransactionListPage",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "<p>Bad Request-the request contained data that could not be processed.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "<p>Error payload returned by the bad-request and unauthorized responses, identifying the failure by name, code and detail.</p>",
            "customType": "GeneralError",
            "schema": [
              {
                "name": "name",
                "kind": "required",
                "type": "string",
                "description": "Error name.",
                "minLength": 1
              },
              {
                "name": "code",
                "kind": "required",
                "type": "string",
                "description": "Error code.",
                "minLength": 1
              },
              {
                "name": "reason",
                "kind": "optional",
                "type": "string",
                "description": "Reason why this error occurred.",
                "minLength": 1
              },
              {
                "name": "detail",
                "kind": "required",
                "type": "string",
                "description": "Error details.",
                "minLength": 1
              }
            ],
            "modelRef": "#/components/schemas/GeneralError",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized-the provided credentials were invalid for this endpoint.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "<p>Error payload returned by the bad-request and unauthorized responses, identifying the failure by name, code and detail.</p>",
            "customType": "GeneralError",
            "schema": [
              {
                "name": "name",
                "kind": "required",
                "type": "string",
                "description": "Error name.",
                "minLength": 1
              },
              {
                "name": "code",
                "kind": "required",
                "type": "string",
                "description": "Error code.",
                "minLength": 1
              },
              {
                "name": "reason",
                "kind": "optional",
                "type": "string",
                "description": "Reason why this error occurred.",
                "minLength": 1
              },
              {
                "name": "detail",
                "kind": "required",
                "type": "string",
                "description": "Error details.",
                "minLength": 1
              }
            ],
            "modelRef": "#/components/schemas/GeneralError",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url 'https://api.upstartcommerce.com/v1/tax/transactions?page=integer&pageSize=10' \\\n     --header 'accept: application/json' \\\n     --header 'x-upstart-tenant: string'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/tax/transactions?page=integer&pageSize=10\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/tax/transactions?page=integer&pageSize=10\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/tax/transactions?page=integer&pageSize=10\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json',\n   'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// Success - one page of transaction logs.\n{\n  \"items\": [\n    {\n      \"transactionId\": \"\",\n      \"tenant\": \"\",\n      \"siteId\": \"\",\n      \"cartId\": \"\",\n      \"apiName\": \"\",\n      \"creationDate\": \"\",\n      \"roundTripTime\": \"\"\n    }\n  ],\n  \"page\": 0,\n  \"pageSize\": 0,\n  \"total\": \"\"\n}"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Bad Request-the request contained data that could not be processed.\n{\n  \"name\": \"\",\n  \"code\": \"\",\n  \"reason\": \"\",\n  \"detail\": \"\"\n}"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Unauthorized-the provided credentials were invalid for this endpoint.\n{\n  \"name\": \"\",\n  \"code\": \"\",\n  \"reason\": \"\",\n  \"detail\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}