---
updatedAt: 2026-05-21T05:33:59.000Z
agentTools:
  projectIndex: https://api.basiq.io/llms.txt
---

# List all transactions

List all transactions belonging to a specified user

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Connect",
    "description": "All included utility endpoints for Basiq partners",
    "version": "3.0.0",
    "termsOfService": "https://docs.basiq.io/en/collections/440849-privacy-terms-and-common-questions",
    "license": {
      "name": "Commercial",
      "url": "https://basiq.io"
    }
  },
  "servers": [
    {
      "url": "https://au-api.basiq.io"
    }
  ],
  "paths": {
    "/users/{userId}/transactions": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "summary": "List all transactions",
        "description": "List all transactions belonging to a specified user",
        "operationId": "getTransactions",
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "description": "User identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "This represents the maximum number of items that may be included in the response (maximum of 500). Note that by default 500 items are returned if this value is not specified.",
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": 500
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Transaction filters; connection.id, account.id, transaction.postDate, transaction.status, institution.id, transaction.direction, transaction.class",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a paginated list with a data property that contains an array of transactions. Each entry in the array is a separate object. If no data is returned, the resulting array will be empty. ",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Transactions container object.",
                  "required": [
                    "count",
                    "data",
                    "size",
                    "type"
                  ],
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "Value is \"list\".",
                      "example": "list"
                    },
                    "count": {
                      "type": "integer",
                      "description": "Count of the transactions in the response.",
                      "format": "int64",
                      "example": 100
                    },
                    "size": {
                      "type": "integer",
                      "format": "int64",
                      "example": 500
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "required": [
                          "id",
                          "status",
                          "description",
                          "reference",
                          "account",
                          "amount",
                          "currency",
                          "class",
                          "subClass",
                          "connection",
                          "direction",
                          "enrich",
                          "institution",
                          "links",
                          "postDate",
                          "transactionDate",
                          "type"
                        ],
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Value is \"transaction\".",
                            "example": "transaction"
                          },
                          "id": {
                            "type": "string",
                            "description": "Uniquely identifies the transaction for this connection. Note that when a connection is refreshed pending transactions will receive new id's, whilst posted transactions will receive the same id's as before the refresh.",
                            "example": "d3de1ca1"
                          },
                          "status": {
                            "type": "string",
                            "description": "Identifies if a transaction is pending or posted. A pending transaction is an approved debit or credit transaction that has not been fully processed yet (i.e. has not been posted). Note that pending transactions are not available for all institutions.",
                            "example": "posted",
                            "enum": [
                              "pending",
                              "posted"
                            ]
                          },
                          "description": {
                            "type": "string",
                            "description": "The transaction description as submitted by the institution."
                          },
                          "reference": {
                            "type": "string",
                            "description": "The reference for the transaction provided by the originating institution."
                          },
                          "amount": {
                            "type": "string",
                            "description": "Transaction amount. Outgoing funds are expressed as negative values.",
                            "example": "123.12"
                          },
                          "currency": {
                            "type": "string",
                            "description": "Standard 3 character currency codes as per ISO-4217.",
                            "enum": [
                              "AUD",
                              "USD",
                              "GBP"
                            ]
                          },
                          "account": {
                            "type": "string",
                            "description": "The id of the account resource the transaction belongs to.",
                            "example": "d3de1ca1"
                          },
                          "balance": {
                            "type": "string",
                            "description": "Account balance at the time the transaction was completed. Included for Web connection integrations. CDR does not supply transaction balance, so this field will be empty for CDR connections.",
                            "example": "123.12"
                          },
                          "direction": {
                            "type": "string",
                            "description": "Identifies if the transaction is of debit or credit type.",
                            "example": "debit",
                            "enum": [
                              "debit",
                              "credit"
                            ]
                          },
                          "class": {
                            "type": "string",
                            "description": "Describes the class(type) of transaction.",
                            "example": "payment",
                            "enum": [
                              "bank-fee",
                              "payment",
                              "cash-withdrawal",
                              "transfer",
                              "loan-interest",
                              "refund",
                              "direct-credit",
                              "interest",
                              "loan-repayment"
                            ]
                          },
                          "institution": {
                            "type": "string",
                            "description": "The id of the institution resource the transaction originated from.",
                            "example": "AU00000"
                          },
                          "connection": {
                            "type": "string",
                            "description": "The id of the connection resource that was used to retrieve the transaction.",
                            "example": "d3de1ca1"
                          },
                          "transactionDate": {
                            "type": "string",
                            "description": "Date that the user executed the transaction as provided by the institution. Note that not all transactions provide this value (varies by institution) e.g. \"2017-11-10T00:00:00Z\"",
                            "example": null
                          },
                          "paymentDetails": {
                            "type": "object",
                            "nullable": true,
                            "properties": {
                              "bpay": {
                                "type": "object",
                                "properties": {
                                  "billerCode": {
                                    "type": "string",
                                    "description": "BPAY Biller Code for the transaction."
                                  },
                                  "billerName": {
                                    "type": "string",
                                    "description": "Name of the BPAY biller for the transaction."
                                  },
                                  "crn": {
                                    "type": "string",
                                    "description": "CRN for the transaction."
                                  }
                                }
                              },
                              "apcaNumber": {
                                "type": "string",
                                "description": "6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.\n"
                              }
                            }
                          },
                          "postDate": {
                            "type": "string",
                            "description": "Date the transaction was posted as provided by the institution. This value is null if the record is pending. e.g. \"2017-11-10T21:46:44Z\" or 2017-11-10T00:00:00Z.",
                            "example": "2018-11-02T00:00:00Z"
                          },
                          "subClass": {
                            "type": "object",
                            "description": "The subClass attribute will only return values for payment transactions (i.e. will be empty for all others) plus [new] bank fee transactions for those relating to account conduct such as account overdrawn and direct debit dishonours.",
                            "properties": {
                              "code": {
                                "type": "string",
                                "description": "code",
                                "example": 722
                              },
                              "title": {
                                "type": "string",
                                "description": "SubClass title",
                                "example": "Cafes and Restaurants"
                              }
                            }
                          },
                          "enrich": {
                            "required": [
                              "cleanDescription",
                              "tags",
                              "category",
                              "location",
                              "merchant"
                            ],
                            "type": "object",
                            "properties": {
                              "location": {
                                "type": "object",
                                "nullable": true,
                                "properties": {
                                  "country": {
                                    "type": "string",
                                    "description": "Country",
                                    "example": "Australia"
                                  },
                                  "formattedAddress": {
                                    "type": "string",
                                    "description": "Address",
                                    "example": "1/39 E Esplanade, Manly NSW 2095"
                                  },
                                  "geometry": {
                                    "type": "object",
                                    "properties": {
                                      "lat": {
                                        "type": "string",
                                        "description": "Latitude",
                                        "example": "-33.79988520000001"
                                      },
                                      "lng": {
                                        "type": "string",
                                        "description": "Longitude",
                                        "example": "151.2858021"
                                      }
                                    },
                                    "x-readme-ref-name": "TransactionsGeometry"
                                  },
                                  "postalCode": {
                                    "type": "string",
                                    "description": "Postal Code",
                                    "example": "2095"
                                  },
                                  "route": {
                                    "type": "string",
                                    "description": "Route Name",
                                    "example": "E Esplanade"
                                  },
                                  "routeNo": {
                                    "type": "string",
                                    "description": "Route Number",
                                    "example": "29"
                                  },
                                  "state": {
                                    "type": "string",
                                    "description": "State",
                                    "example": "NSW"
                                  },
                                  "suburb": {
                                    "type": "string",
                                    "description": "Suburb",
                                    "example": "Manly"
                                  }
                                },
                                "x-readme-ref-name": "TransactionsLocation"
                              },
                              "cleanDescription": {
                                "type": "string",
                                "description": "",
                                "x-readme-ref-name": "TransactionscleanDescription"
                              },
                              "tags": {
                                "type": "array",
                                "items": {
                                  "type": "string",
                                  "description": "This array contains tags that are formatted as `tag_name:tag_value`. Each `tag_name` corresponds to a specific category of transaction information, and the `tag_value` provides a detailed classification within that category.\n- For example, the `card` tag_name will have a 4-digit number as tag_value (e.g., \"card:4615\").\n- The `conduct` tag_name can have values like `card`, `overdrawn`, `cheque`, `atm`, `currency`, `late`, `admin`, `dishonour`, `interest` (e.g., \"conduct:cheque\").\n- The `governmentPayment` tag_name might have values such as `centrelink`, `centrelinkCarers`, `crisisSupport`, `education`, `familyAllowance`, `jobseekerPymt`, `medicare`, `newstart`, `pension`, `rentalAssistance`, `vetAffairs`, `youthAllowance` (e.g., \"governmentPayment:centrelink\").\n- The `income` tag_name could include values like `childSupport`, `insurance`, `investment`, `rent`, `salary`, `superannuation` (e.g., \"income:salary\").\n- The `liability` tag_name could include values like `afterpay`, `arl collect pty ltd`, `australian recoveries`, `axess`, `azora`, `baycorp`, `beforepay`, `brighte`, `bundll`, `cash converters`, `cash direct`, `cashngo`, `cash stop`, `cash train`, `ccc`, `cfmg pty ltd`, `charter mercantile`, `cigno`, `collectau`, `collection house`, `complete credit solutions`, `credit collection services`, `credit corp`, `creditline`, `deferit`, `dun and bradstreet`, `earnd`, `edstart`, `finance one`, `fundo`, `fupay`, `gem visa`, `humm`, `indebted`, `klarna`, `latitude`, `laybuy`, `limepay`, `lion finance`, `money3`, `moneyloop`, `mypaynow`, `nimble`, `nine25`, `openpay`, `panthera`, `payitlater`, `payright`, `pioneer credit`, `plenti`, `probe`, `q card`, `quickapay`, `spotmenow`, `sunshine loans`, `tapmypay`, `wagetap`, `wallet wizard`, `zip pay` (e.g., \"liability:afterpay\").\n- The `third-party` tag_name might include values like `apple pay`, `google`, `paypal`, `sp`, `sq` (e.g., \"third-party:paypal\").\n- The `creditCard` tag_name is used with the value `creditCard` (e.g., \"creditCard:creditCard\").\n- The `expense` tag_name is used with the value `rent` (e.g., \"expense:rent\").\n- The `loan` tag_name is used with the value `loan repayment` (e.g., \"loan:loan repayment\").\n- The `mortgage` tag_name could include values like `afg home loans`, `aims`, `amo group`, `athena`, `aussie`, `bluestone`, `clickloans`, `emoney`, `express reverse mortgage`, `firstmac`, `fox symes`, `freedom lend`, `freedom loans`, `funding`, `heartland reverse mortgages`, `homeloans`, `homestar`, `homestart`, `household capital`, `illawarra home loans`, `keystart`, `la trobe financial`, `liberty financial`, `loans`, `mortgage house`, `mortgage offset`, `mortgageport`, `mortgage repayment`, `onetwo`, `online home loans`, `pacific mortgage group`, `pepper money`, `qantas money`, `reduce home loans`, `resi`, `resimac`, `sucasa`, `switzer home loans`, `ticToc`, `unloan`, `vmg`, `well money` (e.g., \"mortgage:afg home loans\").\n",
                                  "example": "conduct:dishonour"
                                },
                                "description": "This field contains an array of strings, each representing a specific tag for the transaction. The format of each string should be `tag_name:tag_value`, where `tag_name` defines the type of transaction (e.g., `card`, `income`, `mortgage`), and `tag_value` provides additional details (e.g., \"card:4615\"). The tags help classify and identify transactions based on various criteria.\n\n      - card:4615\n      - conduct:card\n      - conduct:overdrawn\n      - conduct:cheque\n      - conduct:atm\n      - conduct:currency\n      - conduct:late\n      - conduct:admin\n      - conduct:dishonour\n      - conduct:interest\n      - governmentPayment:centrelink\n      - governmentPayment:centrelinkCarers\n      - governmentPayment:crisisSupport\n      - governmentPayment:education\n      - governmentPayment:familyAllowance\n      - governmentPayment:jobseekerPymt\n      - governmentPayment:medicare\n      - governmentPayment:newstart\n      - governmentPayment:pension\n      - governmentPayment:rentalAssistance\n      - governmentPayment:vetAffairs\n      - governmentPayment:youthAllowance\n      - income:childSupport\n      - income:insurance\n      - income:investment\n      - income:rent\n      - income:salary\n      - income:superannuation\n      - liability:afterpay\n      - liability:arl collect pty ltd\n      - liability:australian recoveries\n      - liability:axess\n      - liability:azora\n      - liability:baycorp\n      - liability:beforepay\n      - liability:brighte\n      - liability:bundll\n      - liability:cash converters\n      - liability:cash direct\n      - liability:cashngo\n      - liability:cash stop\n      - liability:cash train\n      - liability:ccc\n      - liability:cfmg pty ltd\n      - liability:charter mercantile\n      - liability:cigno\n      - liability:collectau\n      - liability:collection house\n      - liability:complete credit solutions\n      - liability:credit collection services\n      - liability:credit corp\n      - liability:creditline\n      - liability:deferit\n      - liability:dun and bradstreet\n      - liability:earnd\n      - liability:edstart\n      - liability:finance one\n      - liability:fundo\n      - liability:fupay\n      - liability:gem visa\n      - liability:humm\n      - liability:indebted\n      - liability:klarna\n      - liability:latitude\n      - liability:laybuy\n      - liability:limepay\n      - liability:lion finance\n      - liability:money3\n      - liability:moneyloop\n      - liability:mypaynow\n      - liability:nimble\n      - liability:nine25\n      - liability:openpay\n      - liability:panthera\n      - liability:payitlater\n      - liability:payright\n      - liability:pioneer credit\n      - liability:plenti\n      - liability:probe\n      - liability:q card\n      - liability:quickapay\n      - liability:spotmenow\n      - liability:sunshine loans\n      - liability:tapmypay\n      - liability:wagetap\n      - liability:wallet wizard\n      - liability:zip pay\n      - third-party:apple pay\n      - third-party:google\n      - third-party:paypal\n      - third-party:sp\n      - third-party:sq\n      - creditCard:creditCard\n      - expense:rent\n      - loan:loan repayment\n      - mortgage:afg home loans\n      - mortgage:aims\n      - mortgage:amo group\n      - mortgage:athena\n      - mortgage:aussie\n      - mortgage:bluestone\n      - mortgage:clickloans\n      - mortgage:emoney\n      - mortgage:express reverse mortgage\n      - mortgage:firstmac\n      - mortgage:fox symes\n      - mortgage:freedom lend\n      - mortgage:freedom loans\n      - mortgage:funding\n      - mortgage:heartland reverse mortgages\n      - mortgage:homeloans\n      - mortgage:homestar\n      - mortgage:homestart\n      - mortgage:household capital\n      - mortgage:illawarra home loans\n      - mortgage:keystart\n      - mortgage:la trobe financial\n      - mortgage:liberty financial\n      - mortgage:loans\n      - mortgage:mortgage house\n      - mortgage:mortgage offset\n      - mortgage:mortgageport\n      - mortgage:mortgage repayment\n      - mortgage:onetwo\n      - mortgage:online home loans\n      - mortgage:pacific mortgage group\n      - mortgage:pepper money\n      - mortgage:qantas money\n      - mortgage:reduce home loans\n      - mortgage:resi\n      - mortgage:resimac\n      - mortgage:sucasa\n      - mortgage:switzer home loans\n      - mortgage:ticToc\n      - mortgage:unloan\n      - mortgage:vmg\n      - mortgage:well money\n",
                                "x-readme-ref-name": "Transactionstags"
                              },
                              "merchant": {
                                "required": [
                                  "id",
                                  "businessName",
                                  "ABN",
                                  "website",
                                  "logoMaster",
                                  "logoThumb"
                                ],
                                "type": "object",
                                "nullable": true,
                                "properties": {
                                  "id": {
                                    "type": "string",
                                    "description": "id",
                                    "example": "ae4a051c-4791-11e8-8750-0a87c0279fe8"
                                  },
                                  "businessName": {
                                    "type": "string",
                                    "description": "Merchant name",
                                    "example": "Garfish Manly"
                                  },
                                  "ABN": {
                                    "type": "string",
                                    "description": "ABN",
                                    "example": "90065628864"
                                  },
                                  "logoMaster": {
                                    "type": "string",
                                    "description": "full merchant logo",
                                    "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-master.png"
                                  },
                                  "logoThumb": {
                                    "type": "string",
                                    "description": "thumbnail merchant logo",
                                    "example": "https://enrich-enrichmerchantslogobucket-x62p53eh5ld9.s3-ap-southeast-2.amazonaws.com/officeworks-thumb.png"
                                  },
                                  "phoneNumber": {
                                    "type": "object",
                                    "properties": {
                                      "international": {
                                        "type": "string",
                                        "description": "International Phone Number",
                                        "example": "+61 2 9977 0707"
                                      },
                                      "local": {
                                        "type": "string",
                                        "description": "Local Phone Number",
                                        "example": "(02) 9977 0707"
                                      }
                                    },
                                    "x-readme-ref-name": "TransactionsPhoneNumber"
                                  },
                                  "website": {
                                    "type": "string",
                                    "description": "Merchant Website",
                                    "example": "http://garfish.com.au/garfish-manly/"
                                  }
                                },
                                "x-readme-ref-name": "TransactionsMerchant"
                              },
                              "category": {
                                "type": "object",
                                "nullable": true,
                                "properties": {
                                  "matchType": {
                                    "type": "string",
                                    "description": "Indicates the method used to match a payment transaction with a merchant or business classification code. Description for each enum; merchantFull: Indicates an exact match between the transaction and a known merchant in the database. merchantPartial: Suggests a partial match with a merchant, usually based on substring or fuzzy logic. mcc: Match is done using the Merchant Category Code associated with the transaction. ml: Match is determined through machine learning algorithms for classification. none: Match is not found. \n",
                                    "enum": [
                                      "merchantFull",
                                      "merchantPartial",
                                      "mcc",
                                      "ml",
                                      "none"
                                    ],
                                    "example": "merchantfull"
                                  },
                                  "matchScore": {
                                    "type": "string",
                                    "description": "The confidence score for the matchType which is a float value between 0 and 1. The higher the number, the higher the confidence in the match.",
                                    "example": "1.0"
                                  },
                                  "mcc": {
                                    "type": "object",
                                    "description": "Merchant category codes returned from Data holders.",
                                    "properties": {
                                      "code": {
                                        "type": "string",
                                        "description": "code",
                                        "example": "txMccCode-25028"
                                      },
                                      "title": {
                                        "type": "string",
                                        "description": "title",
                                        "example": ""
                                      }
                                    }
                                  },
                                  "anzsic": {
                                    "type": "object",
                                    "properties": {
                                      "division": {
                                        "type": "object",
                                        "properties": {
                                          "title": {
                                            "type": "string",
                                            "description": "Division Details",
                                            "example": "Accommodation and Food Services"
                                          },
                                          "code": {
                                            "type": "string",
                                            "description": "Division Code",
                                            "example": "H"
                                          }
                                        },
                                        "x-readme-ref-name": "TransactionsDivision"
                                      },
                                      "subdivision": {
                                        "type": "object",
                                        "properties": {
                                          "code": {
                                            "type": "string",
                                            "description": "Subdivision Code",
                                            "example": "45"
                                          },
                                          "title": {
                                            "type": "string",
                                            "description": "Subdivision Details",
                                            "example": "Food and Beverage Services"
                                          }
                                        },
                                        "x-readme-ref-name": "TransactionsSubdivision"
                                      },
                                      "group": {
                                        "type": "object",
                                        "properties": {
                                          "code": {
                                            "type": "string",
                                            "description": "Group Code",
                                            "example": "451"
                                          },
                                          "title": {
                                            "type": "string",
                                            "description": "Group Details",
                                            "example": "Cafes, Restaurants and Takeaway Food Services"
                                          }
                                        },
                                        "x-readme-ref-name": "TransactionsGroup"
                                      },
                                      "class": {
                                        "type": "object",
                                        "properties": {
                                          "title": {
                                            "type": "string",
                                            "description": "Class Details",
                                            "example": "Cafes and Restaurants"
                                          },
                                          "code": {
                                            "type": "string",
                                            "description": "Class Code",
                                            "example": "4511"
                                          }
                                        },
                                        "x-readme-ref-name": "TransactionsClass"
                                      },
                                      "subclass": {
                                        "type": "object",
                                        "properties": {
                                          "title": {
                                            "type": "string",
                                            "description": "SubClass Details",
                                            "example": "Cafes and Restaurants"
                                          },
                                          "code": {
                                            "type": "string",
                                            "description": "SubClass Code",
                                            "example": "451100"
                                          }
                                        },
                                        "x-readme-ref-name": "TransactionsSubClass"
                                      }
                                    },
                                    "x-readme-ref-name": "TransactionsAnzsic"
                                  }
                                },
                                "x-readme-ref-name": "TransactionsCategory"
                              }
                            },
                            "x-readme-ref-name": "TransactionsEnrich"
                          },
                          "links": {
                            "required": [
                              "account",
                              "connection",
                              "institution",
                              "self"
                            ],
                            "type": "object",
                            "properties": {
                              "account": {
                                "type": "string",
                                "description": "Url of the account.",
                                "example": "https://au-api.basiq.io/users/6a52015e/accounts/31eb30a0"
                              },
                              "institution": {
                                "type": "string",
                                "description": "Url of the institution.",
                                "example": "https://au-api.basiq.io/institutions/AU00000"
                              },
                              "self": {
                                "type": "string",
                                "description": "Transaction self reference.",
                                "example": "https://au-api.basiq.io/users/6a52015e/transactions/2082c765"
                              }
                            },
                            "x-readme-ref-name": "TransactionLinks"
                          }
                        },
                        "x-readme-ref-name": "TransactionData"
                      }
                    },
                    "links": {
                      "required": [
                        "self"
                      ],
                      "type": "object",
                      "properties": {
                        "self": {
                          "type": "string",
                          "description": "Self reference url.",
                          "example": "https://au-api.basiq.io/users/ea3a81/transactions"
                        },
                        "next": {
                          "type": "string",
                          "description": "URL to the next result page when there are more than 500 transactions.",
                          "example": "https://au-api.basiq.io/users/6a52015e/transactions?next=bf1ec9d4"
                        }
                      },
                      "x-readme-ref-name": "TransactionsGetLinks"
                    }
                  },
                  "description": "A transaction object is created whenever money is debited or credited from a particular account.",
                  "x-readme-ref-name": "TransactionsGetResource"
                }
              }
            }
          },
          "400": {
            "description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "correlationId",
                    "data",
                    "type"
                  ],
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "Always \"list\".",
                      "example": "list"
                    },
                    "correlationId": {
                      "type": "string",
                      "description": "Unique identifier for this particular occurrence of the problem.",
                      "example": "ac5ah5i"
                    },
                    "data": {
                      "type": "array",
                      "description": "Error data.",
                      "items": {
                        "required": [
                          "code",
                          "type"
                        ],
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "string",
                            "description": "Application-specific error code, expressed as a string value.",
                            "example": "parameter-not-valid",
                            "enum": [
                              "parameter-not-supplied",
                              "parameter-not-valid",
                              "unsupported-accept",
                              "invalid-content",
                              "institution-not-supported",
                              "invalid-credentials"
                            ]
                          },
                          "detail": {
                            "type": "string",
                            "description": "Human-readable explanation specific to this occurrence of the problem.",
                            "example": "The provided filter parameter is in invalid format or unsupported."
                          },
                          "source": {
                            "title": "Source",
                            "type": "object",
                            "properties": {
                              "parameter": {
                                "type": "string",
                                "description": "String indicating which URI query parameter caused the error.",
                                "example": "userId"
                              },
                              "pointer": {
                                "type": "string",
                                "description": "Location to the object or attribute that the error relates to.",
                                "example": "users/userId"
                              }
                            },
                            "description": "An object containing references to the source of the error.",
                            "x-readme-ref-name": "Source"
                          },
                          "title": {
                            "type": "string",
                            "description": "Title of the error",
                            "example": "Parameter not valid."
                          },
                          "type": {
                            "type": "string",
                            "description": "Type of the response, always \"error\"",
                            "example": "error"
                          }
                        }
                      }
                    }
                  },
                  "x-readme-ref-name": "BadRequestError"
                },
                "examples": {
                  "Bad Request": {
                    "value": {
                      "type": "list",
                      "correlationId": "ac5ah5i",
                      "data": [
                        {
                          "type": "error",
                          "title": "Parameter not valid.",
                          "code": "parameter-not-valid",
                          "detail": "ID value is not valid.",
                          "source": {
                            "parameter": "id"
                          }
                        }
                      ]
                    }
                  },
                  "Invalid Filters": {
                    "value": {
                      "type": "list",
                      "correlationId": "ac5ah55",
                      "data": [
                        {
                          "type": "error",
                          "code": "parameter-not-valid",
                          "title": "Parameter value is not valid",
                          "detail": "The provided filter parameter is in invalid format or unsupported",
                          "source": {
                            "parameter": "filter"
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "correlationId",
                    "data",
                    "type"
                  ],
                  "type": "object",
                  "properties": {
                    "correlationId": {
                      "type": "string",
                      "description": "Unique identifier for this particular occurrence of the problem.",
                      "example": "ac5ah5i"
                    },
                    "data": {
                      "type": "array",
                      "description": "Error data.",
                      "items": {
                        "required": [
                          "code",
                          "source",
                          "type"
                        ],
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "string",
                            "description": "Application-specific error code, expressed as a string value.",
                            "example": "forbidden-access",
                            "enum": [
                              "forbidden-access",
                              "no-production-access",
                              "access-denied"
                            ]
                          },
                          "detail": {
                            "type": "string",
                            "description": "Human-readable explanation specific to this occurrence of the problem.",
                            "example": "Access to this resource is forbidden."
                          },
                          "source": {
                            "title": "Source",
                            "type": "object",
                            "properties": {
                              "parameter": {
                                "type": "string",
                                "description": "String indicating which URI query parameter caused the error.",
                                "example": "userId"
                              },
                              "pointer": {
                                "type": "string",
                                "description": "Location to the object or attribute that the error relates to.",
                                "example": "users/userId"
                              }
                            },
                            "description": "An object containing references to the source of the error.",
                            "x-readme-ref-name": "Source"
                          },
                          "title": {
                            "type": "string",
                            "description": "Title of the error",
                            "example": "Forbidden Access"
                          },
                          "type": {
                            "type": "string",
                            "description": "Type of the response, always \"error\"",
                            "example": "error"
                          }
                        }
                      }
                    },
                    "type": {
                      "type": "string",
                      "description": "Always \"list\".",
                      "example": "list"
                    }
                  },
                  "x-readme-ref-name": "ForbiddenAccessError"
                }
              }
            }
          },
          "404": {
            "description": "Returns error indicating that server can't find requested resource.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "correlationId",
                    "data",
                    "type"
                  ],
                  "type": "object",
                  "properties": {
                    "correlationId": {
                      "type": "string",
                      "description": "Unique identifier for this particular occurrence of the problem.",
                      "example": "ac5ah5i"
                    },
                    "data": {
                      "type": "array",
                      "description": "Error data.",
                      "items": {
                        "required": [
                          "code",
                          "type"
                        ],
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "string",
                            "description": "Application-specific error code, expressed as a string value.",
                            "example": "resource-not-found",
                            "enum": [
                              "resource-not-found"
                            ]
                          },
                          "detail": {
                            "type": "string",
                            "description": "Human-readable explanation specific to this occurrence of the problem.",
                            "example": "Resource not found."
                          },
                          "title": {
                            "type": "string",
                            "description": "Title of the error",
                            "example": "Requested resource is not found."
                          },
                          "type": {
                            "type": "string",
                            "description": "Type of the response, always \"error\"",
                            "example": "error"
                          }
                        }
                      }
                    },
                    "type": {
                      "type": "string",
                      "description": "Always \"list\".",
                      "example": "list"
                    }
                  },
                  "x-readme-ref-name": "NotFoundError"
                }
              }
            }
          },
          "500": {
            "description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "correlationId",
                    "data",
                    "type"
                  ],
                  "type": "object",
                  "properties": {
                    "correlationId": {
                      "type": "string",
                      "description": "Unique identifier for this particular occurrence of the problem.",
                      "example": "ac5ah5i"
                    },
                    "data": {
                      "type": "array",
                      "description": "Error data.",
                      "items": {
                        "required": [
                          "code",
                          "type"
                        ],
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "string",
                            "description": "Application-specific error code, expressed as a string value.",
                            "example": "internal-server-error",
                            "enum": [
                              "internal-server-error"
                            ]
                          },
                          "detail": {
                            "type": "string",
                            "description": "Human-readable explanation specific to this occurrence of the problem.",
                            "example": "Internal Server error. Contact support."
                          },
                          "title": {
                            "type": "string",
                            "description": "Title of the error",
                            "example": "Internal Server error."
                          },
                          "type": {
                            "type": "string",
                            "description": "Type of the response, always \"error\"",
                            "example": "error"
                          }
                        }
                      }
                    },
                    "type": {
                      "type": "string",
                      "description": "Always \"list\".",
                      "example": "list"
                    }
                  },
                  "x-readme-ref-name": "InternalServerError"
                }
              }
            }
          }
        },
        "security": [
          {
            "services_token": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-default": "Basic NjMxMjNmMWMtZjYxMy00ZjMyLWFiYzUtYzBhZDdhYTY2YmU1OjQ3NWYwMzhkLTBlZmItNGM1ZS1iMzQ0LTAzMzYxOTkyYTRlMw=="
      },
      "services_token": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "api_key": []
    },
    {
      "services_token": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true,
    "samples-languages": [
      "curl",
      "node",
      "ruby",
      "javascript",
      "python"
    ]
  }
}
```