curl --request GET \
--url https://api.zivio.net/api/v4/bank_accounts \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/bank_accounts"
headers = {
"Authorization": "Bearer <token>",
"zivio-tenant-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};
fetch('https://api.zivio.net/api/v4/bank_accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zivio.net/api/v4/bank_accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"zivio-tenant-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zivio.net/api/v4/bank_accounts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("zivio-tenant-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zivio.net/api/v4/bank_accounts")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/bank_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"bank_accounts": [
{
"id": 101,
"owner_id": 501,
"owner_type": "Example owner_type",
"owner_name": null,
"account_holder_name": "Acme Corporation",
"account_holder_type": "Example account_holder_type",
"account_kind": "Example account_kind",
"currency": "GBP",
"country_code": "Example country_code",
"bank_name": "Example bank_name",
"branch_name": null,
"branch_number": null,
"account_number": null,
"sort_code": null,
"routing_number": null,
"iban": null,
"bic_swift_code": null,
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"owner_id": 502,
"owner_type": "Example owner_type",
"owner_name": null,
"account_holder_name": "Global Services Ltd",
"account_holder_type": "Example account_holder_type",
"account_kind": "Example account_kind",
"currency": "GBP",
"country_code": "Example country_code",
"bank_name": "Example bank_name",
"branch_name": null,
"branch_number": null,
"account_number": null,
"sort_code": null,
"routing_number": null,
"iban": null,
"bic_swift_code": null,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
]
}List Bank Accounts
Retrieve a paginated list of bank_accounts. Use filters to narrow results.
Filtering
Use the filter[<attribute>] parameter to filter results. Multiple filters are combined with AND logic.
Basic Examples
# Equality (implicit)
GET /api/v4/bank_accounts?filter[owner_type]=active
# Multiple values (implicit IN)
GET /api/v4/bank_accounts?filter[owner_type]=draft,pending
# With explicit operator
GET /api/v4/bank_accounts?filter[created_at][gte]=2024-01-01
# Range query
GET /api/v4/bank_accounts?filter[owner_id][between]=10,100
# Multiple filters (AND)
GET /api/v4/bank_accounts?filter[owner_type]=active&filter[owner_id][gte]=10
Available Attributes
| Attribute | Type | Operators | Permitted Values |
|---|---|---|---|
| account_holder_type | string | eq, not_eq, in, not_in, like, not_like | - |
| account_kind | string | eq, not_eq, in, not_in, like, not_like | - |
| bank_name | string | eq, not_eq, in, not_in, like, not_like | - |
| country_code | string | eq, not_eq, in, not_in, like, not_like | - |
| created_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| currency | string | eq, not_eq, in, not_in, like, not_like | - |
| id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| owner_id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| owner_type | string | eq, not_eq, in, not_in, like, not_like | - |
| updated_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
OR Conditions
Use or[group] to combine filter groups with OR logic. Filters within a group are ANDed:
# Simple OR
GET /api/v4/bank_accounts?or[1][owner_type]=pending&or[2][owner_type]=active
# Complex OR (owner_type=pending AND owner_id>=10) OR (owner_type=active)
GET /api/v4/bank_accounts?or[1][owner_type]=pending&or[1][owner_id][gte]=10&or[2][owner_type]=active
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)
GET /api/v4/bank_accounts?sort[created_at]=
# Descending
GET /api/v4/bank_accounts?sort[created_at]=desc
# Combined with filters
GET /api/v4/bank_accounts?filter[owner_type]=active&sort[created_at]=desc
curl --request GET \
--url https://api.zivio.net/api/v4/bank_accounts \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/bank_accounts"
headers = {
"Authorization": "Bearer <token>",
"zivio-tenant-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};
fetch('https://api.zivio.net/api/v4/bank_accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zivio.net/api/v4/bank_accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"zivio-tenant-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zivio.net/api/v4/bank_accounts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("zivio-tenant-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zivio.net/api/v4/bank_accounts")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/bank_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"bank_accounts": [
{
"id": 101,
"owner_id": 501,
"owner_type": "Example owner_type",
"owner_name": null,
"account_holder_name": "Acme Corporation",
"account_holder_type": "Example account_holder_type",
"account_kind": "Example account_kind",
"currency": "GBP",
"country_code": "Example country_code",
"bank_name": "Example bank_name",
"branch_name": null,
"branch_number": null,
"account_number": null,
"sort_code": null,
"routing_number": null,
"iban": null,
"bic_swift_code": null,
"created_at": "2024-01-16T10:30:00+00:00",
"updated_at": "2024-01-16T10:30:00+00:00"
},
{
"id": 102,
"owner_id": 502,
"owner_type": "Example owner_type",
"owner_name": null,
"account_holder_name": "Global Services Ltd",
"account_holder_type": "Example account_holder_type",
"account_kind": "Example account_kind",
"currency": "GBP",
"country_code": "Example country_code",
"bank_name": "Example bank_name",
"branch_name": null,
"branch_number": null,
"account_number": null,
"sort_code": null,
"routing_number": null,
"iban": null,
"bic_swift_code": null,
"created_at": "2024-01-17T10:30:00+00:00",
"updated_at": "2024-01-17T10:30:00+00:00"
}
]
}Authorizations
OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.
Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.
Query Parameters
Page number for pagination
Number of results per page (max 100)
x <= 100Filterable attributes:
integer (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): id, owner_id datetime (operators: eq, not_eq, gt, gte, lt, lte, between): created_at, updated_at string (operators: eq, not_eq, in, not_in, like, not_like): account_holder_type, account_kind, bank_name, country_code, currency, owner_type
Note: like is a case-insensitive substring match — pass the bare term (filter[title][like]=redesign). Do not add % wildcards; they are not needed.
OR condition groups. Filters within a group are ANDed; groups are ORed.
Syntax: or[group_key][<attribute>]=value or or[group_key][<attribute>][operator]=value
Examples:
- Simple OR:
or[1][state]=draft&or[2][state]=pending - Complex:
or[1][state]=draft&or[1][budget][gte]=50000&or[2][state]=closed - With custom fields:
or[1][cf][priority]=high&or[2][state]=pending
Group keys can be any string (1, 2, a, b, etc.) - they just need to be unique.
Sort results by attribute. Direction defaults to ascending.
Syntax: sort[<attribute>]= (ascending) or sort[<attribute>]=desc (descending)
Sortable attributes: account_holder_type, account_kind, bank_name, country_code, created_at, currency, id, owner_id, owner_type, updated_at
Examples:
- Ascending:
sort[created_at]=orsort[created_at]=asc - Descending:
sort[created_at]=desc
Response
List of bank_accounts
Show child attributes
Show child attributes

