action up_get_accounts { label: "List accounts" description: "Retrieve a paginated list of all accounts for the currently\nauthenticated user. The returned list is paginated and can be scrolled\nby following the `prev` and `next` links where present.\n" provider: up method: GET path: "/accounts" encoding: json input: { type: "object" properties: { "filter[accountType]": { description: "Specifies the type of bank account. Currently returned values are `SAVER`\nand `TRANSACTIONAL`.\n" enum: ["SAVER", "TRANSACTIONAL"] type: "object" } "filter[ownershipType]": { description: "Specifies the structure under which a bank account is owned. Currently\nreturned values are `INDIVIDUAL` and `JOINT`.\n" enum: ["INDIVIDUAL", "JOINT"] type: "object" } "page[size]": { type: "integer" } } additionalProperties: false } output: { type: "object" description: "Successful response to get all accounts. This returns a paginated list of\naccounts, which can be scrolled by following the `prev` and `next` links\nif present.\n" required: ["data", "links"] properties: { data: { type: "array" description: "The list of accounts returned in this response.\n" items: { type: "object" description: "Provides information about an Up bank account.\n" required: ["type", "id", "attributes", "relationships"] properties: { attributes: { type: "object" required: ["displayName", "accountType", "ownershipType", "balance", "createdAt"] properties: { accountType: { description: "The bank account type of this account.\n" type: "object" } balance: { description: "The available balance of the account, taking into account any amounts\nthat are currently on hold.\n" type: "object" } createdAt: { type: "string" format: "date-time" description: "The date-time at which this account was first opened.\n" } displayName: { type: "string" description: "The name associated with the account in the Up application.\n" } ownershipType: { description: "The ownership structure for this account.\n" type: "object" } } } id: { type: "string" description: "The unique identifier for this account.\n" } links: { type: "object" required: ["self"] properties: { self: { type: "string" description: "The canonical link to this resource within the API.\n" } } } relationships: { type: "object" required: ["transactions"] properties: { transactions: { type: "object" properties: { links: { type: "object" required: ["related"] properties: { related: { type: "string" description: "The link to retrieve the related resource(s) in this relationship.\n" } } } } } } } type: { type: "string" description: "The type of this resource: `accounts`" } } } } links: { type: "object" required: ["next", "prev"] properties: { next: { type: "string" description: "The link to the next page in the results. If this value is `null`\nthere is no next page.\n" } prev: { type: "string" description: "The link to the previous page in the results. If this value is `null`\nthere is no previous page.\n" } } } } } }