Reference · Accounts
List accounts
GET
https://api.paygoro.com/v1/accountsLists every bank account in the workspace — Paygoro business accounts and connected external accounts — with current balances.
Authorization
Requires a bearer API key with accounts:read. See Authentication.
Query parameters
| Name | Type | Description |
|---|---|---|
companyId | string | Restrict to one legal entity. Omit to include every entity in the workspace. |
Response
200 · application/json
| Field | Type | Description |
|---|---|---|
data | array of object | |
id | string | Opaque resource id. |
companyId | string | Opaque resource id. |
name | string | null | Account name as reported by the bank. |
nickname | string | null | User-chosen display name, when set. |
iban | string | null | |
bic | string | null | |
currency | string | ISO 4217 currency code, e.g. EUR.max 3 chars |
balance | string | null | Booked balance. Null when the bank has not reported one yet. |
availableBalance | string | null | |
balanceUpdatedAt | string (date-time) | null | |
type | "depository" | "credit" | "other" | |
provider | "paygoro" | "connected" | `paygoro` for a Paygoro business account, `connected` for an external bank linked to the workspace. |
institutionName | string | null | Name of the bank holding the account. |
enabled | boolean | False when the user has hidden the account from views. |
createdAt | string (date-time) | Timestamp in RFC 3339 format (UTC). |
Errors
| 400 | BAD_REQUEST | The request was malformed or failed validation. |
| 401 | UNAUTHORIZED | Missing, malformed, expired or revoked API key. |
| 403 | FORBIDDEN | The API key does not have the scope this operation requires. |
| 404 | NOT_FOUND | No resource with this id exists in your workspace, or a `companyId` filter does not match one of your companies. |
| 429 | TOO_MANY_REQUESTS | Rate limit exceeded. Retry after the `Retry-After` header. |
All errors share one envelope — see Errors.